Module {laminr}R Documentation

Module

Description

A LaminDB module containing one or more registries.

Active bindings

name

(character(1))
Get the name of the module.

Methods

Public methods


Method new()

Creates an instance of this R6 class. This class should not be instantiated directly, but rather by connecting to a LaminDB instance using the connect() function.

Usage
Module$new(instance, api, module_name, module_schema)
Arguments
instance

The instance the module belongs to.

api

The API for the instance.

module_name

The name of the module.

module_schema

The schema of the module.


Method get_registries()

Get the registries in the module.

Usage
Module$get_registries()
Returns

A list of Registry objects.


Method get_registry()

Get a registry by name.

Usage
Module$get_registry(registry_name)
Arguments
registry_name

The name of the registry.

Returns

A Registry object.


Method get_registry_names()

Get the names of the registries in the module. E.g. c("User", "Artifact").

Usage
Module$get_registry_names()
Returns

A character vector of registry names.


Method print()

Print a Module

Usage
Module$print(style = TRUE)
Arguments
style

Logical, whether the output is styled using ANSI codes.


Method to_string()

Create a string representation of a Module

Usage
Module$to_string(style = FALSE)
Arguments
style

Logical, whether the output is styled using ANSI codes

Returns

A cli::cli_ansi_string if style = TRUE or a character vector


[Package laminr version 0.3.0 Index]