apdb_cli Namespace Reference

Functions
None	main (Sequence[str]|None args=None)
None	_create_sql_subcommand (argparse._SubParsersAction subparsers)
None	_create_cassandra_subcommand (argparse._SubParsersAction subparsers)
None	_list_cassandra_subcommand (argparse._SubParsersAction subparsers)
None	_delete_cassandra_subcommand (argparse._SubParsersAction subparsers)
None	_list_index_subcommand (argparse._SubParsersAction subparsers)
None	_metadata_subcommand (argparse._SubParsersAction subparsers)
None	_metadata_show_subcommand (argparse._SubParsersAction subparsers)
None	_metadata_get_subcommand (argparse._SubParsersAction subparsers)
None	_metadata_set_subcommand (argparse._SubParsersAction subparsers)
None	_metadata_delete_subcommand (argparse._SubParsersAction subparsers)

Function Documentation

_create_cassandra_subcommand()

None apdb_cli._create_cassandra_subcommand ( argparse._SubParsersAction subparsers )

protected

Definition at line 68 of file apdb_cli.py.

def _create_cassandra_subcommand(subparsers: argparse._SubParsersAction) -> None:
    parser = subparsers.add_parser("create-cassandra", help="Create new APDB instance in Cassandra cluster.")
    parser.add_argument("host", help="One or more host names for Cassandra cluster.", nargs="+")
    parser.add_argument(
        "keyspace", help="Cassandra keyspace name for APDB tables, will be created if does not exist."
    )
    parser.add_argument("output_config", help="Name of the new configuration file for created APDB instance.")
    options.common_apdb_options(parser)
    options.cassandra_config_options(parser)
    parser.add_argument(
        "--drop", help="If True then drop existing tables.", default=False, action="store_true"
    )
    parser.set_defaults(method=scripts.create_cassandra)
 
 

_create_sql_subcommand()

None apdb_cli._create_sql_subcommand ( argparse._SubParsersAction subparsers )

protected

Definition at line 56 of file apdb_cli.py.

def _create_sql_subcommand(subparsers: argparse._SubParsersAction) -> None:
    parser = subparsers.add_parser("create-sql", help="Create new APDB instance in SQL database.")
    parser.add_argument("db_url", help="Database URL in SQLAlchemy format for APDB instance.")
    parser.add_argument("output_config", help="Name of the new configuration file for created APDB instance.")
    options.common_apdb_options(parser)
    options.sql_config_options(parser)
    parser.add_argument(
        "--drop", help="If True then drop existing tables.", default=False, action="store_true"
    )
    parser.set_defaults(method=scripts.create_sql)
 
 

_delete_cassandra_subcommand()

None apdb_cli._delete_cassandra_subcommand ( argparse._SubParsersAction subparsers )

protected

Definition at line 96 of file apdb_cli.py.

def _delete_cassandra_subcommand(subparsers: argparse._SubParsersAction) -> None:
    parser = subparsers.add_parser("delete-cassandra", help="Delete APDB instance from Cassandra cluster.")
    parser.add_argument("host", help="One of the host names for Cassandra cluster.")
    parser.add_argument("keyspace", help="Cassandra keyspace name for APDB tables.")
    parser.add_argument(
        "-y",
        "--confirm",
        help="Assume 'yes' answer for confirmation.",
        default=False,
        action="store_true",
    )
    parser.set_defaults(method=scripts.delete_cassandra)
 
 

_list_cassandra_subcommand()

None apdb_cli._list_cassandra_subcommand ( argparse._SubParsersAction subparsers )

protected

Definition at line 83 of file apdb_cli.py.

def _list_cassandra_subcommand(subparsers: argparse._SubParsersAction) -> None:
    parser = subparsers.add_parser("list-cassandra", help="List APDB instances in Cassandra cluster.")
    parser.add_argument("host", help="One of the host names for Cassandra cluster.")
    parser.add_argument(
        "-v",
        "--verbose",
        help="Provide full list of roles and associated permissions.",
        default=False,
        action="store_true",
    )
    parser.set_defaults(method=scripts.list_cassandra)
 
 

_list_index_subcommand()

None apdb_cli._list_index_subcommand ( argparse._SubParsersAction subparsers )

protected

Definition at line 110 of file apdb_cli.py.

def _list_index_subcommand(subparsers: argparse._SubParsersAction) -> None:
    parser = subparsers.add_parser("list-index", help="List contents of APDB index file.")
    parser.add_argument(
        "index_path", help="Location of index file, if missing then $DAX_APDB_INDEX_URI is used.", nargs="?"
    )
    parser.set_defaults(method=scripts.list_index)
 
 

_metadata_delete_subcommand()

None apdb_cli._metadata_delete_subcommand ( argparse._SubParsersAction subparsers )

protected

Definition at line 163 of file apdb_cli.py.

def _metadata_delete_subcommand(subparsers: argparse._SubParsersAction) -> None:
    parser = subparsers.add_parser("delete", help="Delete metadata item.")
    parser.add_argument("config", help="Path or URI of APDB configuration file.")
    parser.add_argument("key", help="Metadata key, arbitrary string.")
    parser.set_defaults(method=scripts.metadata_delete)

_metadata_get_subcommand()

None apdb_cli._metadata_get_subcommand ( argparse._SubParsersAction subparsers )

protected

Definition at line 141 of file apdb_cli.py.

def _metadata_get_subcommand(subparsers: argparse._SubParsersAction) -> None:
    parser = subparsers.add_parser("get", help="Print value of the metadata item.")
    parser.add_argument("config", help="Path or URI of APDB configuration file.")
    parser.add_argument("key", help="Metadata key, arbitrary string.")
    parser.set_defaults(method=scripts.metadata_get)
 
 

_metadata_set_subcommand()

None apdb_cli._metadata_set_subcommand ( argparse._SubParsersAction subparsers )

protected

Definition at line 148 of file apdb_cli.py.

def _metadata_set_subcommand(subparsers: argparse._SubParsersAction) -> None:
    parser = subparsers.add_parser("set", help="Add or update metadata item.")
    parser.add_argument(
        "-f",
        "--force",
        help="Force update of the existing key.",
        default=False,
        action="store_true",
    )
    parser.add_argument("config", help="Path or URI of APDB configuration file.")
    parser.add_argument("key", help="Metadata key, arbitrary string.")
    parser.add_argument("value", help="Corresponding metadata value.")
    parser.set_defaults(method=scripts.metadata_set)
 
 

_metadata_show_subcommand()

None apdb_cli._metadata_show_subcommand ( argparse._SubParsersAction subparsers )

protected

Definition at line 127 of file apdb_cli.py.

def _metadata_show_subcommand(subparsers: argparse._SubParsersAction) -> None:
    parser = subparsers.add_parser("show", help="Show contents of APDB metadata table.")
    parser.add_argument(
        "-j",
        "--json",
        dest="use_json",
        help="Dump metadata in JSON format.",
        default=False,
        action="store_true",
    )
    parser.add_argument("config", help="Path or URI of APDB configuration file.")
    parser.set_defaults(method=scripts.metadata_show)
 
 

_metadata_subcommand()

None apdb_cli._metadata_subcommand ( argparse._SubParsersAction subparsers )

protected

Definition at line 118 of file apdb_cli.py.

def _metadata_subcommand(subparsers: argparse._SubParsersAction) -> None:
    parser = subparsers.add_parser("metadata", help="Operations with APDB metadata table.")
    subparsers = parser.add_subparsers(title="available subcommands", required=True)
    _metadata_set_subcommand(subparsers)
    _metadata_get_subcommand(subparsers)
    _metadata_show_subcommand(subparsers)
    _metadata_delete_subcommand(subparsers)
 
 

main()

None apdb_cli.main

(

Sequence[str] | None

args = None

)

APDB command line tools.

Definition at line 34 of file apdb_cli.py.

def main(args: Sequence[str] | None = None) -> None:
    """APDB command line tools."""
    parser = argparse.ArgumentParser(description="APDB command line tools")
    log_cli = LoggingCli(parser)
 
    subparsers = parser.add_subparsers(title="available subcommands", required=True)
    _create_sql_subcommand(subparsers)
    _create_cassandra_subcommand(subparsers)
    _list_cassandra_subcommand(subparsers)
    _delete_cassandra_subcommand(subparsers)
    _list_index_subcommand(subparsers)
    _metadata_subcommand(subparsers)
 
    parsed_args = parser.parse_args(args)
    log_cli.process_args(parsed_args)
 
    kwargs = vars(parsed_args)
    # Strip keywords not understood by scripts.
    method = kwargs.pop("method")
    method(**kwargs)