Coverage for python / lsst / dax / apdb / scripts / create_cassandra.py: 25%

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 

31 

32from lsst.resources import ResourcePath 

33 

34from ..cassandra import ApdbCassandra, CreateTableOptions 

35 

36 

37def create_cassandra( 

38 output_config: str, ra_dec_columns: str | None, table_options: str | None = None, **kwargs: Any 

39) -> None: 

40 """Create new APDB instance in Cassandra cluster. 

41 

42 Parameters 

43 ---------- 

44 output_config : `str` 

45 Name of the file to write APDB configuration. 

46 ra_dec_columns : `str` or `None` 

47 Comma-separated list of names for ra/dec columns in DiaObject table. 

48 table_options : `str`, optional 

49 Path or URI of the YAML file with table options. 

50 **kwargs 

51 Keyword arguments passed to `ApdbCassandra.init_database` method. 

52 """ 

53 options = _read_table_options(table_options) 

54 ra_dec_tuple: tuple[str, str] | None = None 

55 if ra_dec_columns: 

56 ra_dec_list = ra_dec_columns.split(",") 

57 if len(ra_dec_list) != 2: 

58 raise ValueError(f"--ra-dec-columns must specify exactly two columns: {ra_dec_columns}") 

59 ra_dec_tuple = (ra_dec_list[0], ra_dec_list[1]) 

60 kwargs["hosts"] = kwargs.pop("host") 

61 config = ApdbCassandra.init_database(ra_dec_columns=ra_dec_tuple, table_options=options, **kwargs) 

62 config.save(output_config) 

63 if output_config.endswith(".py"): 

64 warnings.warn( 

65 "APDB configuration is now saved in YAML format, " 

66 "output file should use .yaml extension instead of .py." 

67 ) 

68 

69 

70def _read_table_options(table_options: str | None = None) -> CreateTableOptions | None: 

71 """Read contents of the table options file.""" 

72 if not table_options: 

73 return None 

74 

75 res = ResourcePath(table_options) 

76 content = res.read() 

77 stream = io.BytesIO(content) 

78 if model_data := yaml.load(stream, Loader=yaml.SafeLoader): 

79 return CreateTableOptions.model_validate(model_data) 

80 return None