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) |
| None | _convert_legacy_config_subcommand (argparse._SubParsersAction subparsers) |
| None | _metrics_subcommand (argparse._SubParsersAction subparsers) |
| None | _metrics_log_to_influx (argparse._SubParsersAction subparsers) |
Function Documentation
◆ _convert_legacy_config_subcommand()
|
protected |
Definition at line 172 of file apdb_cli.py.
172def _convert_legacy_config_subcommand(subparsers: argparse._SubParsersAction) -> None:
173 parser = subparsers.add_parser("convert-legacy-config", help="Convert legacy pex_config to YAML.")
174 parser.add_argument("legacy_config", help="Path or URI of APDB legacy configuration file.")
175 parser.add_argument("new_config", help="Path or URI to write new YAML configuration file.")
176 parser.set_defaults(method=scripts.convert_legacy_config)
177
178
◆ _create_cassandra_subcommand()
|
protected |
Definition at line 70 of file apdb_cli.py.
70def _create_cassandra_subcommand(subparsers: argparse._SubParsersAction) -> None:
71 parser = subparsers.add_parser("create-cassandra", help="Create new APDB instance in Cassandra cluster.")
72 parser.add_argument("host", help="One or more host names for Cassandra cluster.", nargs="+")
73 parser.add_argument(
74 "keyspace", help="Cassandra keyspace name for APDB tables, will be created if does not exist."
75 )
76 parser.add_argument("output_config", help="Name of the new configuration file for created APDB instance.")
77 options.common_apdb_options(parser)
78 options.cassandra_config_options(parser)
79 parser.add_argument(
80 "--drop", help="If True then drop existing tables.", default=False, action="store_true"
81 )
82 parser.set_defaults(method=scripts.create_cassandra)
83
84
None common_apdb_options(argparse.ArgumentParser parser)
Definition options.py:67
None cassandra_config_options(argparse.ArgumentParser parser)
Definition options.py:99
◆ _create_sql_subcommand()
|
protected |
Definition at line 58 of file apdb_cli.py.
58def _create_sql_subcommand(subparsers: argparse._SubParsersAction) -> None:
59 parser = subparsers.add_parser("create-sql", help="Create new APDB instance in SQL database.")
60 parser.add_argument("db_url", help="Database URL in SQLAlchemy format for APDB instance.")
61 parser.add_argument("output_config", help="Name of the new configuration file for created APDB instance.")
62 options.common_apdb_options(parser)
63 options.sql_config_options(parser)
64 parser.add_argument(
65 "--drop", help="If True then drop existing tables.", default=False, action="store_true"
66 )
67 parser.set_defaults(method=scripts.create_sql)
68
69
None sql_config_options(argparse.ArgumentParser parser)
Definition options.py:78
◆ _delete_cassandra_subcommand()
|
protected |
Definition at line 98 of file apdb_cli.py.
98def _delete_cassandra_subcommand(subparsers: argparse._SubParsersAction) -> None:
99 parser = subparsers.add_parser("delete-cassandra", help="Delete APDB instance from Cassandra cluster.")
100 parser.add_argument("host", help="One of the host names for Cassandra cluster.")
101 parser.add_argument("keyspace", help="Cassandra keyspace name for APDB tables.")
102 parser.add_argument(
103 "-y",
104 "--confirm",
105 help="Assume 'yes' answer for confirmation.",
106 default=False,
107 action="store_true",
108 )
109 parser.set_defaults(method=scripts.delete_cassandra)
110
111
◆ _list_cassandra_subcommand()
|
protected |
Definition at line 85 of file apdb_cli.py.
85def _list_cassandra_subcommand(subparsers: argparse._SubParsersAction) -> None:
86 parser = subparsers.add_parser("list-cassandra", help="List APDB instances in Cassandra cluster.")
87 parser.add_argument("host", help="One of the host names for Cassandra cluster.")
88 parser.add_argument(
89 "-v",
90 "--verbose",
91 help="Provide full list of roles and associated permissions.",
92 default=False,
93 action="store_true",
94 )
95 parser.set_defaults(method=scripts.list_cassandra)
96
97
◆ _list_index_subcommand()
|
protected |
Definition at line 112 of file apdb_cli.py.
112def _list_index_subcommand(subparsers: argparse._SubParsersAction) -> None:
113 parser = subparsers.add_parser("list-index", help="List contents of APDB index file.")
114 parser.add_argument(
115 "index_path", help="Location of index file, if missing then $DAX_APDB_INDEX_URI is used.", nargs="?"
116 )
117 parser.set_defaults(method=scripts.list_index)
118
119
◆ _metadata_delete_subcommand()
|
protected |
Definition at line 165 of file apdb_cli.py.
165def _metadata_delete_subcommand(subparsers: argparse._SubParsersAction) -> None:
166 parser = subparsers.add_parser("delete", help="Delete metadata item.")
167 parser.add_argument("config", help="Path or URI of APDB configuration file.")
168 parser.add_argument("key", help="Metadata key, arbitrary string.")
169 parser.set_defaults(method=scripts.metadata_delete)
170
171
◆ _metadata_get_subcommand()
|
protected |
Definition at line 143 of file apdb_cli.py.
143def _metadata_get_subcommand(subparsers: argparse._SubParsersAction) -> None:
144 parser = subparsers.add_parser("get", help="Print value of the metadata item.")
145 parser.add_argument("config", help="Path or URI of APDB configuration file.")
146 parser.add_argument("key", help="Metadata key, arbitrary string.")
147 parser.set_defaults(method=scripts.metadata_get)
148
149
◆ _metadata_set_subcommand()
|
protected |
Definition at line 150 of file apdb_cli.py.
150def _metadata_set_subcommand(subparsers: argparse._SubParsersAction) -> None:
151 parser = subparsers.add_parser("set", help="Add or update metadata item.")
152 parser.add_argument(
153 "-f",
154 "--force",
155 help="Force update of the existing key.",
156 default=False,
157 action="store_true",
158 )
159 parser.add_argument("config", help="Path or URI of APDB configuration file.")
160 parser.add_argument("key", help="Metadata key, arbitrary string.")
161 parser.add_argument("value", help="Corresponding metadata value.")
162 parser.set_defaults(method=scripts.metadata_set)
163
164
◆ _metadata_show_subcommand()
|
protected |
Definition at line 129 of file apdb_cli.py.
129def _metadata_show_subcommand(subparsers: argparse._SubParsersAction) -> None:
130 parser = subparsers.add_parser("show", help="Show contents of APDB metadata table.")
131 parser.add_argument(
132 "-j",
133 "--json",
134 dest="use_json",
135 help="Dump metadata in JSON format.",
136 default=False,
137 action="store_true",
138 )
139 parser.add_argument("config", help="Path or URI of APDB configuration file.")
140 parser.set_defaults(method=scripts.metadata_show)
141
142
◆ _metadata_subcommand()
|
protected |
Definition at line 120 of file apdb_cli.py.
120def _metadata_subcommand(subparsers: argparse._SubParsersAction) -> None:
121 parser = subparsers.add_parser("metadata", help="Operations with APDB metadata table.")
122 subparsers = parser.add_subparsers(title="available subcommands", required=True)
123 _metadata_set_subcommand(subparsers)
124 _metadata_get_subcommand(subparsers)
125 _metadata_show_subcommand(subparsers)
126 _metadata_delete_subcommand(subparsers)
127
128
◆ _metrics_log_to_influx()
|
protected |
Definition at line 185 of file apdb_cli.py.
185def _metrics_log_to_influx(subparsers: argparse._SubParsersAction) -> None:
186 parser = subparsers.add_parser(
187 "log-to-infux", help="Extract metrics from log files and dump as InfluxDB data."
188 )
189 parser.add_argument(
190 "file", help="Name(s) of the log file to parse, '-' to read from standard input.", nargs="+"
191 )
192 parser.add_argument(
193 "-c",
194 "--context-keys",
195 help=("Names of keys to extract from message context, comma-separated. " "Default: %(default)s "),
196 default="instrument,visit,detector,day_obs",
197 metavar="KEY[,KEY,...]",
198 )
199 parser.add_argument(
200 "-t",
201 "--extra-tags",
202 help="Extra tags and their values, comma-separated.",
203 default="",
204 metavar="TAG=VALUE[,TAG=VALUE...]",
205 )
206 parser.add_argument(
207 "-r",
208 "--replication",
209 help="Log is produced by replication service.",
210 action="store_true",
211 default=False,
212 )
213 parser.add_argument(
214 "-p",
215 "--prefix",
216 help="Additional prefix for metrics names.",
217 default="",
218 )
219 parser.add_argument(
220 "-H",
221 "--no-header",
222 help="Do not add DML header.",
223 action="store_true",
224 default=False,
225 )
226 parser.add_argument(
227 "-d",
228 "--header-database",
229 help="Database name to use for header, default: %(default)s.",
230 default="telegraf",
231 )
232 parser.add_argument(
233 "--fix-row-count",
234 help="Fix incorrect inserted row counts by parsing additional data from logs.",
235 action="store_true",
236 default=False,
237 )
238 parser.set_defaults(method=scripts.metrics_log_to_influx)
◆ _metrics_subcommand()
|
protected |
Definition at line 179 of file apdb_cli.py.
179def _metrics_subcommand(subparsers: argparse._SubParsersAction) -> None:
180 parser = subparsers.add_parser("metrics", help="Operations with metrics produced by APDB.")
181 subparsers = parser.add_subparsers(title="available subcommands", required=True)
182 _metrics_log_to_influx(subparsers)
183
184
◆ main()
| None apdb_cli.main | ( | Sequence[str] | None | args = None | ) |
APDB command line tools.
Definition at line 34 of file apdb_cli.py.
35 """APDB command line tools."""
36 parser = argparse.ArgumentParser(description="APDB command line tools")
37 log_cli = LoggingCli(parser)
38
39 subparsers = parser.add_subparsers(title="available subcommands", required=True)
40 _create_sql_subcommand(subparsers)
41 _create_cassandra_subcommand(subparsers)
42 _list_cassandra_subcommand(subparsers)
43 _delete_cassandra_subcommand(subparsers)
44 _list_index_subcommand(subparsers)
45 _metadata_subcommand(subparsers)
46 _convert_legacy_config_subcommand(subparsers)
47 _metrics_subcommand(subparsers)
48
49 parsed_args = parser.parse_args(args)
50 log_cli.process_args(parsed_args)
51
52 kwargs = vars(parsed_args)
53 # Strip keywords not understood by scripts.
54 method = kwargs.pop("method")
55 method(**kwargs)
56
57
Generated on Sun Aug 10 2025 17:52:55 for LSST Applications by
1.13.2