LSST Applications 24.1.6,g063fba187b+56b85ce14a,g0f08755f38+df8a265115,g12f32b3c4e+891a09f10d,g1524ad2192+7a5d7b3fbd,g1653933729+a8ce1bb630,g168dd56ebc+a8ce1bb630,g28da252d5a+07cb1400be,g2bbee38e9b+ae03bbfc84,g2bc492864f+ae03bbfc84,g3156d2b45e+6e55a43351,g347aa1857d+ae03bbfc84,g35bb328faa+a8ce1bb630,g3a166c0a6a+ae03bbfc84,g3e281a1b8c+c5dd892a6c,g414038480c+6b9177ef31,g41af890bb2+8f257c4c0b,g781aacb6e4+a8ce1bb630,g7af13505b9+7137b3b17d,g80478fca09+6df6903293,g82479be7b0+091ce1d07f,g858d7b2824+df8a265115,g89c8672015+f4add4ffd5,g9125e01d80+a8ce1bb630,g9726552aa6+414189b318,ga5288a1d22+4a2bca08d7,gacef1a1666+c9a8ff65f4,gb58c049af0+d64f4d3760,gbcfae0f0a0+de1d42d831,gc28159a63d+ae03bbfc84,gcf0d15dbbd+72117bf34e,gda6a2b7d83+72117bf34e,gdaeeff99f8+1711a396fd,ge500cccec5+c8c9c9af63,ge79ae78c31+ae03bbfc84,gf0baf85859+c1f95f4921,gfa517265be+df8a265115,gfa999e8aa5+17cd334064,gfb92a5be7c+df8a265115
LSST Data Management Base Package
Loading...
Searching...
No Matches
options.py
Go to the documentation of this file.
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/>.
21
22from __future__ import annotations
23
24__all__ = ["cassandra_config_options", "common_apdb_options", "sql_config_options"]
25
26import argparse
27from typing import TYPE_CHECKING, Any
28
29from ..apdb import ApdbConfig
30from ..cassandra import ApdbCassandraConfig
31from ..sql import ApdbSqlConfig
32
33if TYPE_CHECKING:
34 from lsst.pex.config import Field
35
36
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)
51
52
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, metavar="NUMBER", type=int)
60 _option_from_pex_field(group, ApdbConfig.read_forced_sources_months, metavar="NUMBER", type=int)
62 group, ApdbConfig.use_insert_id, name="--enable-replica", action="store_true", default=False
63 )
64
65
66# Options for fields in ApdbSqlConfig, db_url is not included.
67def sql_config_options(parser: argparse.ArgumentParser) -> None:
68 """Define SQL backend configuration options."""
69 group = parser.add_argument_group("SQL backend options")
70 _option_from_pex_field(group, ApdbSqlConfig.namespace, metavar="IDENTIFIER")
71 _option_from_pex_field(group, ApdbSqlConfig.connection_timeout, type=int, metavar="SECONDS")
73 group, ApdbSqlConfig.dia_object_index, choices=["baseline", "pix_id_iov", "last_object_table"]
74 )
75 _option_from_pex_field(group, ApdbSqlConfig.htm_level, type=int)
76 _option_from_pex_field(group, ApdbSqlConfig.htm_index_column)
78 group,
79 ApdbSqlConfig.ra_dec_columns,
80 help="Names of ra/dec columns in DiaObject table, comma-separated.",
81 metavar="RA_COLUMN,DEC_COLUMN",
82 )
83 _option_from_pex_field(group, ApdbSqlConfig.prefix)
84
85
86# Options for fields in ApdbCassandraConfig, contact_points is not included.
87def cassandra_config_options(parser: argparse.ArgumentParser) -> None:
88 """Define Cassandra backend configuration options."""
89 group = parser.add_argument_group("Cassandra backend options")
91 group,
92 ApdbCassandraConfig.use_insert_id_skips_diaobjects,
93 name="--replica-skips-diaobjects",
94 action="store_true",
95 )
96 _option_from_pex_field(group, ApdbCassandraConfig.port, type=int, metavar="PORT")
97 _option_from_pex_field(group, ApdbCassandraConfig.username, metavar="USER")
98 _option_from_pex_field(group, ApdbCassandraConfig.prefix)
99 group.add_argument(
100 "--replication-factor", help="Replication factor used when creating new keyspace.", type=int
101 )
102 group.add_argument(
103 "--table-options", help="Path or URI of YAML file containing table options.", metavar="URI"
104 )
106 group, ApdbCassandraConfig.read_consistency, choices=["ONE", "TWO", "THREE", "QUORUM", "ALL"]
107 )
109 group, ApdbCassandraConfig.write_consistency, choices=["ONE", "TWO", "THREE", "QUORUM", "ALL"]
110 )
111 _option_from_pex_field(group, ApdbCassandraConfig.read_timeout, type=int, metavar="SECONDS")
112 _option_from_pex_field(group, ApdbCassandraConfig.write_timeout, type=int, metavar="SECONDS")
114 group,
115 ApdbCassandraConfig.ra_dec_columns,
116 help="Names of ra/dec columns in DiaObject table, comma-separated.",
117 metavar="RA_COLUMN,DEC_COLUMN",
118 )
119 group = parser.add_argument_group("Cassandra partitioning options")
120 _option_from_pex_field(group, ApdbCassandraConfig.part_pixelization, metavar="NAME")
121 _option_from_pex_field(group, ApdbCassandraConfig.part_pix_level, type=int, metavar="LEVEL")
122 _option_from_pex_field(group, ApdbCassandraConfig.time_partition_tables, action="store_true")
123 _option_from_pex_field(group, ApdbCassandraConfig.time_partition_start, metavar="TIME")
124 _option_from_pex_field(group, ApdbCassandraConfig.time_partition_end, metavar="TIME")
None common_apdb_options(argparse.ArgumentParser parser)
Definition options.py:54
None cassandra_config_options(argparse.ArgumentParser parser)
Definition options.py:87
None _option_from_pex_field(argparse._ArgumentGroup group, Field field, *str|None name=None, str|None help=None, **Any kwargs)
Definition options.py:44
None sql_config_options(argparse.ArgumentParser parser)
Definition options.py:67