lsst.dax.apdb.scripts.create_sql Namespace Reference

Functions
None	create_sql (str output_config, str|None ra_dec_columns, **Any kwargs)

Function Documentation

create_sql()

None lsst.dax.apdb.scripts.create_sql.create_sql	(	str	output_config,
		str | None	ra_dec_columns,
		**Any	kwargs )

Create new APDB instance in SQL database.

Parameters
----------
output_config : `str`
    Name of the file to write APDB configuration.
ra_dec_columns : `str` or `None`
    Comma-separated list of names for ra/dec columns in DiaObject table.
**kwargs
    Keyword arguments passed to `ApdbSql.init_database` method.

Definition at line 32 of file create_sql.py.

def create_sql(output_config: str, ra_dec_columns: str | None, **kwargs: Any) -> None:
    """Create new APDB instance in SQL database.
 
    Parameters
    ----------
    output_config : `str`
        Name of the file to write APDB configuration.
    ra_dec_columns : `str` or `None`
        Comma-separated list of names for ra/dec columns in DiaObject table.
    **kwargs
        Keyword arguments passed to `ApdbSql.init_database` method.
    """
    ra_dec_tuple: tuple[str, str] | None = None
    if ra_dec_columns:
        ra_dec_list = ra_dec_columns.split(",")
        if len(ra_dec_list) != 2:
            raise ValueError(f"--ra-dec-columns must specify exactly two columns: {ra_dec_columns}")
        ra_dec_tuple = (ra_dec_list[0], ra_dec_list[1])
    config = ApdbSql.init_database(ra_dec_columns=ra_dec_tuple, **kwargs)
    config.save(output_config)
    if output_config.endswith(".py"):
        warnings.warn(
            "APDB configuration is now saved in YAML format, "
            "output file should use .yaml extension instead of .py."
        )