apdb_cli Namespace Reference

Functions
int|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)
None	_convert_legacy_config_subcommand (argparse._SubParsersAction subparsers)
None	_metrics_subcommand (argparse._SubParsersAction subparsers)
None	_metrics_log_to_influx (argparse._SubParsersAction subparsers)
None	_replication_subcommand (argparse._SubParsersAction subparsers)
None	_replication_list_chunks_subcommand (argparse._SubParsersAction subparsers)
None	_replication_delete_chunks_subcommand (argparse._SubParsersAction subparsers)
None	_partition_subcommand (argparse._SubParsersAction subparsers)
None	_partition_show_temporal (argparse._SubParsersAction subparsers)
None	_partition_extend_temporal (argparse._SubParsersAction subparsers)
None	_partition_delete_temporal (argparse._SubParsersAction subparsers)

Function Documentation

_convert_legacy_config_subcommand()

None apdb_cli._convert_legacy_config_subcommand ( argparse._SubParsersAction subparsers )

protected

Definition at line 174 of file apdb_cli.py.

def _convert_legacy_config_subcommand(subparsers: argparse._SubParsersAction) -> None:
    parser = subparsers.add_parser("convert-legacy-config", help="Convert legacy pex_config to YAML.")
    parser.add_argument("legacy_config", help="Path or URI of APDB legacy configuration file.")
    parser.add_argument("new_config", help="Path or URI to write new YAML configuration file.")
    parser.set_defaults(method=scripts.convert_legacy_config)
 
 

_create_cassandra_subcommand()

None apdb_cli._create_cassandra_subcommand ( argparse._SubParsersAction subparsers )

protected

Definition at line 72 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 60 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 100 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 87 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 114 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 167 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 145 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 152 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 131 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 122 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)
 
 

_metrics_log_to_influx()

None apdb_cli._metrics_log_to_influx ( argparse._SubParsersAction subparsers )

protected

Definition at line 187 of file apdb_cli.py.

def _metrics_log_to_influx(subparsers: argparse._SubParsersAction) -> None:
    parser = subparsers.add_parser(
        "log-to-infux", help="Extract metrics from log files and dump as InfluxDB data."
    )
    parser.add_argument(
        "file", help="Name(s) of the log file to parse, '-' to read from standard input.", nargs="+"
    )
    parser.add_argument(
        "-c",
        "--context-keys",
        help=("Names of keys to extract from message context, comma-separated."),
        default="",
        metavar="KEY[,KEY,...]",
    )
    parser.add_argument(
        "-t",
        "--extra-tags",
        help=(
            "Extra tags and their values, comma-separated. "
            "If tag name is prefixed with minus it will be removed."
        ),
        default="",
        metavar="TAG=VALUE[,-TAG][,TAG=VALUE...]",
    )
    parser.add_argument(
        "-m",
        "--mode",
        help="Source of log file.",
        choices=["ap_proto", "pipeline", "replication", "json_line"],
        default="ap_proto",
    )
    parser.add_argument(
        "-p",
        "--prefix",
        help="Additional prefix for metrics names.",
        default="",
    )
    parser.add_argument(
        "-H",
        "--no-header",
        help="Do not add DML header.",
        action="store_true",
        default=False,
    )
    parser.add_argument(
        "-d",
        "--header-database",
        help="Database name to use for header, default: %(default)s.",
        default="telegraf",
    )
    parser.add_argument(
        "--fix-row-count",
        help="Fix incorrect inserted row counts by parsing additional data from logs.",
        action="store_true",
        default=False,
    )
    parser.set_defaults(method=scripts.metrics_log_to_influx)
 
 

_metrics_subcommand()

None apdb_cli._metrics_subcommand ( argparse._SubParsersAction subparsers )

protected

Definition at line 181 of file apdb_cli.py.

def _metrics_subcommand(subparsers: argparse._SubParsersAction) -> None:
    parser = subparsers.add_parser("metrics", help="Operations with metrics produced by APDB.")
    subparsers = parser.add_subparsers(title="available subcommands", required=True)
    _metrics_log_to_influx(subparsers)
 
 

_partition_delete_temporal()

None apdb_cli._partition_delete_temporal ( argparse._SubParsersAction subparsers )

protected

Definition at line 310 of file apdb_cli.py.

def _partition_delete_temporal(subparsers: argparse._SubParsersAction) -> None:
    parser = subparsers.add_parser("delete-temporal", help="Delete temporal partitions.")
    parser.add_argument("apdb_config", help="Path to the APDB configuration.")
    parser.add_argument("time", help="Timestamps in ISOT format and TAI scale (YYYY-MM-DD[THH:MM:SS]).")
    parser.add_argument(
        "--after",
        action="store_true",
        default=False,
        help="Delete partitions after specified time. Default is to delete partitions before this time.",
    )
    parser.add_argument("--force", action="store_true", default=False, help="Do not ask for confirmation.")
    parser.set_defaults(method=scripts.partition_delete_temporal)

_partition_extend_temporal()

None apdb_cli._partition_extend_temporal ( argparse._SubParsersAction subparsers )

protected

Definition at line 295 of file apdb_cli.py.

def _partition_extend_temporal(subparsers: argparse._SubParsersAction) -> None:
    parser = subparsers.add_parser("extend-temporal", help="Extend the range of temporal partitions.")
    parser.add_argument("apdb_config", help="Path to the APDB configuration.")
    parser.add_argument("time", help="Timestamps in ISOT format and TAI scale (YYYY-MM-DDTHH:MM:SS).")
    parser.add_argument("--past", action="store_true", default=False, help="Extend the range in the past.")
    parser.add_argument(
        "--max-days",
        type=int,
        default=365,
        metavar="NUMBER",
        help="Max. number of days for extension, default: %(default)s.",
    )
    parser.set_defaults(method=scripts.partition_extend_temporal)
 
 

_partition_show_temporal()

None apdb_cli._partition_show_temporal ( argparse._SubParsersAction subparsers )

protected

Definition at line 289 of file apdb_cli.py.

def _partition_show_temporal(subparsers: argparse._SubParsersAction) -> None:
    parser = subparsers.add_parser("show-temporal", help="Print range of temporal partitions.")
    parser.add_argument("apdb_config", help="Path to the APDB configuration.")
    parser.set_defaults(method=scripts.partition_show_temporal)
 
 

_partition_subcommand()

None apdb_cli._partition_subcommand ( argparse._SubParsersAction subparsers )

protected

Definition at line 281 of file apdb_cli.py.

def _partition_subcommand(subparsers: argparse._SubParsersAction) -> None:
    parser = subparsers.add_parser("partition", help="Operations with APDB partitioning.")
    subparsers = parser.add_subparsers(title="available subcommands", required=True)
    _partition_show_temporal(subparsers)
    _partition_extend_temporal(subparsers)
    _partition_delete_temporal(subparsers)
 
 

_replication_delete_chunks_subcommand()

None apdb_cli._replication_delete_chunks_subcommand ( argparse._SubParsersAction subparsers )

protected

Definition at line 259 of file apdb_cli.py.

def _replication_delete_chunks_subcommand(subparsers: argparse._SubParsersAction) -> None:
    parser = subparsers.add_parser("delete-chunks", help="Delete replication chunks from APDB.")
    parser.add_argument("apdb_config", help="Path to the APDB configuration.")
    parser.add_argument(
        "chunk_id", type=int, help="Chunk ID to delete, all earlier chunks are deleted as well."
    )
    parser.add_argument(
        "-p",
        "--print-only",
        help="Only print the list ochunks that will be deleted, but do not delete them.",
        action="store_true",
        default=False,
    )
    parser.add_argument(
        "--force",
        help="Do not ask for confirmation before deleting chunks.",
        action="store_true",
        default=False,
    )
    parser.set_defaults(method=scripts.replication_delete_chunks)
 
 

_replication_list_chunks_subcommand()

None apdb_cli._replication_list_chunks_subcommand ( argparse._SubParsersAction subparsers )

protected

Definition at line 253 of file apdb_cli.py.

def _replication_list_chunks_subcommand(subparsers: argparse._SubParsersAction) -> None:
    parser = subparsers.add_parser("list-chunks", help="Print full list of replication chunks in APDB.")
    parser.add_argument("apdb_config", help="Path to the APDB configuration.")
    parser.set_defaults(method=scripts.replication_list_chunks)
 
 

_replication_subcommand()

None apdb_cli._replication_subcommand ( argparse._SubParsersAction subparsers )

protected

Definition at line 246 of file apdb_cli.py.

def _replication_subcommand(subparsers: argparse._SubParsersAction) -> None:
    parser = subparsers.add_parser("replication", help="Operations with replication tables produced by APDB.")
    subparsers = parser.add_subparsers(title="available subcommands", required=True)
    _replication_list_chunks_subcommand(subparsers)
    _replication_delete_chunks_subcommand(subparsers)
 
 

main()

int | 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) -> int | 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)
    _convert_legacy_config_subcommand(subparsers)
    _metrics_subcommand(subparsers)
    _replication_subcommand(subparsers)
    _partition_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")
    return method(**kwargs)