Skip to content

info

This module defines the DatabaseInfoCommand class, which implements the database info subcommand for the Merlin CLI.

The database info subcommand provides users with summary details about the currently active database configuration and contents. This includes backend type, connection information, and a preview of stored entities.

The command is integrated into the broader Merlin CLI infrastructure through the CommandEntryPoint base class and is registered under the top-level database command group.

DatabaseInfoCommand

Bases: CommandEntryPoint

Handles the database info subcommand, which prints configuration details about the currently active database backend.

Methods:

Name Description
add_parser

Adds the database info command to the CLI parser.
process_command

Processes the CLI input and dispatches the appropriate action.
Source code in merlin/cli/commands/database/info.py 
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
class DatabaseInfoCommand(CommandEntryPoint):
    """
    Handles the `database info` subcommand, which prints configuration
    details about the currently active database backend.

    Methods:
        add_parser: Adds the `database info` command to the CLI parser.
        process_command: Processes the CLI input and dispatches the appropriate action.
    """

    def add_parser(self, subparsers: ArgumentParser):
        """
        Add the `database info` subcommand parser to the CLI argument parser.

        Parameters:
            subparsers (ArgumentParser): The subparsers object to which the `database info`
                subcommand parser will be added.
        """
        parser = subparsers.add_parser(
            "info",
            help="Print information about the database.",
            formatter_class=ArgumentDefaultsHelpFormatter,
        )
        parser.set_defaults(func=self.process_command)

        parser.add_argument(
            "-m",
            "--max-preview",
            type=int,
            default=3,
            help="The maximum number of entities to preview in the output.",
        )

    def process_command(self, args: Namespace):
        """
        Print information about the database to the console.

        Args:
            args: An argparse Namespace containing user arguments.
        """
        # TODO figure out a better way to handle configurations so we don't have to
        # check this in each of the database subcommands
        if args.local:
            initialize_config(local_mode=True)

        merlin_db = MerlinDatabase()
        merlin_db.info(max_preview=args.max_preview)

add_parser(subparsers)

Add the database info subcommand parser to the CLI argument parser.

Parameters:

Name Type Description Default
subparsers ArgumentParser

The subparsers object to which the database info subcommand parser will be added.

 required
Source code in merlin/cli/commands/database/info.py 
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
def add_parser(self, subparsers: ArgumentParser):
    """
    Add the `database info` subcommand parser to the CLI argument parser.

    Parameters:
        subparsers (ArgumentParser): The subparsers object to which the `database info`
            subcommand parser will be added.
    """
    parser = subparsers.add_parser(
        "info",
        help="Print information about the database.",
        formatter_class=ArgumentDefaultsHelpFormatter,
    )
    parser.set_defaults(func=self.process_command)

    parser.add_argument(
        "-m",
        "--max-preview",
        type=int,
        default=3,
        help="The maximum number of entities to preview in the output.",
    )

process_command(args)

Print information about the database to the console.

Parameters:

Name Type Description Default
args Namespace

An argparse Namespace containing user arguments.

 required
Source code in merlin/cli/commands/database/info.py 
60
61
62
63
64
65
66
67
68
69
70
71
72
73
def process_command(self, args: Namespace):
    """
    Print information about the database to the console.

    Args:
        args: An argparse Namespace containing user arguments.
    """
    # TODO figure out a better way to handle configurations so we don't have to
    # check this in each of the database subcommands
    if args.local:
        initialize_config(local_mode=True)

    merlin_db = MerlinDatabase()
    merlin_db.info(max_preview=args.max_preview)