Coverage for python/lsst/dax/apdb/cli/options.py: 22%
47 statements
« prev ^ index » next coverage.py v7.4.4, created at 2024-04-06 04:04 -0700
« prev ^ index » next coverage.py v7.4.4, created at 2024-04-06 04:04 -0700
1# This file is part of dax_apdb
2#
3# Developed for the LSST Data Management System.
4# This product includes software developed by the LSST Project
5# (https://www.lsst.org).
6# See the COPYRIGHT file at the top-level directory of this distribution
7# for details of code ownership.
8#
9# This program is free software: you can redistribute it and/or modify
10# it under the terms of the GNU General Public License as published by
11# the Free Software Foundation, either version 3 of the License, or
12# (at your option) any later version.
13#
14# This program is distributed in the hope that it will be useful,
15# but WITHOUT ANY WARRANTY; without even the implied warranty of
16# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17# GNU General Public License for more details.
18#
19# You should have received a copy of the GNU General Public License
20# along with this program. If not, see <https://www.gnu.org/licenses/>.
22from __future__ import annotations
24__all__ = ["cassandra_config_options", "common_apdb_options", "sql_config_options"]
26import argparse
27from typing import TYPE_CHECKING, Any
29from ..apdb import ApdbConfig
30from ..apdbCassandra import ApdbCassandraConfig
31from ..apdbSql import ApdbSqlConfig
33if TYPE_CHECKING:
34 from lsst.pex.config import Field
37def _option_from_pex_field(
38 group: argparse._ArgumentGroup,
39 field: Field,
40 *,
41 name: str | None = None,
42 help: str | None = None,
43 **kwargs: Any,
44) -> None:
45 """Convert pex_config Field to argparse argument definition."""
46 if name is None:
47 name = "--" + field.name.replace("_", "-")
48 if help is None:
49 help = field.doc
50 group.add_argument(name, dest=field.name, help=help, **kwargs)
53# Options for fields in ApdbConfig.
54def common_apdb_options(parser: argparse.ArgumentParser) -> None:
55 """Define common configuration options."""
56 group = parser.add_argument_group("common APDB options")
57 _option_from_pex_field(group, ApdbConfig.schema_file, metavar="URL")
58 _option_from_pex_field(group, ApdbConfig.schema_name)
59 _option_from_pex_field(group, ApdbConfig.read_sources_months, type=int)
60 _option_from_pex_field(group, ApdbConfig.read_forced_sources_months, type=int)
61 _option_from_pex_field(group, ApdbConfig.use_insert_id, action="store_true", default=False)
64# Options for fields in ApdbSqlConfig, db_url is not included.
65def sql_config_options(parser: argparse.ArgumentParser) -> None:
66 """Define SQL backend configuration options."""
67 group = parser.add_argument_group("SQL backend options")
68 _option_from_pex_field(group, ApdbSqlConfig.namespace, metavar="IDENTIFIER")
69 _option_from_pex_field(group, ApdbSqlConfig.connection_timeout, type=int, metavar="SECONDS")
70 _option_from_pex_field(
71 group, ApdbSqlConfig.dia_object_index, choices=["baseline", "pix_id_iov", "last_object_table"]
72 )
73 _option_from_pex_field(group, ApdbSqlConfig.htm_level, type=int)
74 _option_from_pex_field(group, ApdbSqlConfig.htm_index_column)
75 _option_from_pex_field(
76 group,
77 ApdbSqlConfig.ra_dec_columns,
78 help="Names of ra/dec columns in DiaObject table, comma-separated.",
79 metavar="RA_COLUMN,DEC_COLUMN",
80 )
81 _option_from_pex_field(group, ApdbSqlConfig.prefix)
84# Options for fields in ApdbCassandraConfig, contact_points is not included.
85def cassandra_config_options(parser: argparse.ArgumentParser) -> None:
86 """Define Cassandra backend configuration options."""
87 group = parser.add_argument_group("Cassandra backend options")
88 _option_from_pex_field(group, ApdbCassandraConfig.use_insert_id_skips_diaobjects, action="store_true")
89 _option_from_pex_field(group, ApdbCassandraConfig.port, type=int, metavar="PORT")
90 _option_from_pex_field(group, ApdbCassandraConfig.username, metavar="USER")
91 _option_from_pex_field(group, ApdbCassandraConfig.prefix)
92 group.add_argument(
93 "--replication-factor", help="Replication factor used when creating new keyspace.", type=int
94 )
95 _option_from_pex_field(
96 group, ApdbCassandraConfig.read_consistency, choices=["ONE", "TWO", "THREE", "QUORUM", "ALL"]
97 )
98 _option_from_pex_field(
99 group, ApdbCassandraConfig.write_consistency, choices=["ONE", "TWO", "THREE", "QUORUM", "ALL"]
100 )
101 _option_from_pex_field(group, ApdbCassandraConfig.read_timeout, type=int, metavar="SECONDS")
102 _option_from_pex_field(group, ApdbCassandraConfig.write_timeout, type=int, metavar="SECONDS")
103 _option_from_pex_field(
104 group,
105 ApdbCassandraConfig.ra_dec_columns,
106 help="Names of ra/dec columns in DiaObject table, comma-separated.",
107 metavar="RA_COLUMN,DEC_COLUMN",
108 )
109 group = parser.add_argument_group("Cassandra partitioning options")
110 _option_from_pex_field(group, ApdbCassandraConfig.part_pixelization, metavar="NAME")
111 _option_from_pex_field(group, ApdbCassandraConfig.part_pix_level, type=int, metavar="LEVEL")
112 _option_from_pex_field(group, ApdbCassandraConfig.time_partition_tables, action="store_true")
113 _option_from_pex_field(group, ApdbCassandraConfig.time_partition_start, metavar="TIME")
114 _option_from_pex_field(group, ApdbCassandraConfig.time_partition_end, metavar="TIME")