Coverage for python / lsst / dax / apdb / scripts / create_sql.py: 27%

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_sql"] 

25 

26import warnings 

27from typing import Any 

28 

29from ..sql import ApdbSql 

30 

31 

32def create_sql(output_config: str, ra_dec_columns: str | None, **kwargs: Any) -> None: 

33 """Create new APDB instance in SQL database. 

34 

35 Parameters 

36 ---------- 

37 output_config : `str` 

38 Name of the file to write APDB configuration. 

39 ra_dec_columns : `str` or `None` 

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

41 **kwargs 

42 Keyword arguments passed to `ApdbSql.init_database` method. 

43 """ 

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

45 if ra_dec_columns: 

46 ra_dec_list = ra_dec_columns.split(",") 

47 if len(ra_dec_list) != 2: 

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

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

50 config = ApdbSql.init_database(ra_dec_columns=ra_dec_tuple, **kwargs) 

51 config.save(output_config) 

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

53 warnings.warn( 

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

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

56 )