Loading [MathJax]/extensions/tex2jax.js
LSST Applications g04a91732dc+cc8870d3f5,g07dc498a13+5aa0b8792f,g0fba68d861+80045be308,g1409bbee79+5aa0b8792f,g1a7e361dbc+5aa0b8792f,g1fd858c14a+f64bc332a9,g208c678f98+1ae86710ed,g35bb328faa+fcb1d3bbc8,g4d2262a081+47ad8a29a8,g4d39ba7253+9633a327c1,g4e0f332c67+5d362be553,g53246c7159+fcb1d3bbc8,g60b5630c4e+9633a327c1,g668ecb457e+25d63fd678,g78460c75b0+2f9a1b4bcd,g786e29fd12+cf7ec2a62a,g7b71ed6315+fcb1d3bbc8,g8852436030+8b64ca622a,g89139ef638+5aa0b8792f,g89e1512fd8+04325574d3,g8d6b6b353c+9633a327c1,g9125e01d80+fcb1d3bbc8,g989de1cb63+5aa0b8792f,g9f33ca652e+b196626af7,ga9baa6287d+9633a327c1,gaaedd4e678+5aa0b8792f,gabe3b4be73+1e0a283bba,gb1101e3267+71e32094df,gb58c049af0+f03b321e39,gb90eeb9370+2807b1ad02,gcf25f946ba+8b64ca622a,gd315a588df+a39986a76f,gd6cbbdb0b4+c8606af20c,gd9a9a58781+fcb1d3bbc8,gde0f65d7ad+4e42d81ab7,ge278dab8ac+932305ba37,ge82c20c137+76d20ab76d,gfe73954cf8+a1301e4c20,w.2025.11
LSST Data Management Base Package
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
create_cassandra.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__ = ["create_cassandra"]
25
26import io
27import warnings
28from typing import Any
29
30import yaml
31from lsst.resources import ResourcePath
32
33from ..cassandra import ApdbCassandra, CreateTableOptions
34
35
36def create_cassandra(
37 output_config: str, ra_dec_columns: str | None, table_options: str | None = None, **kwargs: Any
38) -> None:
39 """Create new APDB instance in Cassandra cluster.
40
41 Parameters
42 ----------
43 output_config : `str`
44 Name of the file to write APDB configuration.
45 ra_dec_columns : `str` or `None`
46 Comma-separated list of names for ra/dec columns in DiaObject table.
47 table_options : `str`, optional
48 Path or URI of the YAML file with table options.
49 **kwargs
50 Keyword arguments passed to `ApdbCassandra.init_database` method.
51 """
52 options = _read_table_options(table_options)
53 ra_dec_tuple: tuple[str, str] | None = None
54 if ra_dec_columns:
55 ra_dec_list = ra_dec_columns.split(",")
56 if len(ra_dec_list) != 2:
57 raise ValueError(f"--ra-dec-columns must specify exactly two columns: {ra_dec_columns}")
58 ra_dec_tuple = (ra_dec_list[0], ra_dec_list[1])
59 kwargs["hosts"] = kwargs.pop("host")
60 config = ApdbCassandra.init_database(ra_dec_columns=ra_dec_tuple, table_options=options, **kwargs)
61 config.save(output_config)
62 if output_config.endswith(".py"):
63 warnings.warn(
64 "APDB configuration is now saved in YAML format, "
65 "output file should use .yaml extension instead of .py."
66 )
67
68
69def _read_table_options(table_options: str | None = None) -> CreateTableOptions | None:
70 """Read contents of the table options file."""
71 if not table_options:
72 return None
73
74 res = ResourcePath(table_options)
75 content = res.read()
76 stream = io.BytesIO(content)
77 if model_data := yaml.load(stream, Loader=yaml.SafeLoader):
78 return CreateTableOptions.model_validate(model_data)
79 return None
CreateTableOptions|None _read_table_options(str|None table_options=None)