ApdbCassandraConfig

class lsst.dax.apdb.ApdbCassandraConfig(*args, **kw)

Bases: ApdbConfig

Attributes Summary

contact_points

The list of contact points to try connecting for cluster discovery.

dia_object_columns

List of columns to read from DiaObject, by default read all columns (List, default [])

extra_schema_file

Location of (YAML) configuration file with extra schema, definitions in this file are merged with the definitions in 'schema_file', extending or replacing parts of the schema.

history

keyspace

Default keyspace for operations.

pandas_delay_conv

If True then combine result rows before converting to pandas.

part_pix_level

Pixelization level used for partitioning index.

part_pix_max_ranges

Max number of ranges in pixelization envelope (int, default 64)

part_pixelization

Pixelization used for partitioning index.

prefix

Prefix to add to table names (str, default '')

private_ips

List of internal IP addresses for contact_points.

protocol_version

Cassandra protocol version to use, default is V4 (int, default 0)

query_per_spatial_part

If True then build one query per spacial partition, otherwise build single query.

query_per_time_part

If True then build separate query for each time partition, otherwise build one single query.

ra_dec_columns

Names ra/dec columns in DiaObject table (List, default ['ra', 'decl'])

read_concurrency

Concurrency level for read operations.

read_consistency

Name for consistency level of read operations, default: QUORUM, can be ONE.

read_forced_sources_months

Number of months of history to read from DiaForcedSource (int, default 12)

read_sources_months

Number of months of history to read from DiaSource (int, default 12)

read_timeout

Timeout in seconds for read operations.

schema_file

Location of (YAML) configuration file with standard schema (str, default '${SDM_SCHEMAS_DIR}/yml/apdb.yaml')

schema_name

Name of the schema in YAML configuration file.

time_partition_days

Time partitoning granularity in days, this value must not be changed after database is initialized (int, default 30)

time_partition_end

Ending time for per-partion tables, in yyyy-mm-ddThh:mm:ss format, in TAI This is used only when time_partition_tables is True.

time_partition_start

Starting time for per-partion tables, in yyyy-mm-ddThh:mm:ss format, in TAI.

time_partition_tables

Use per-partition tables for sources instead of partitioning by time (bool, default True)

timer

If True then print/log timing information (bool, default False)

write_consistency

Name for consistency level of write operations, default: QUORUM, can be ONE.

write_timeout

Timeout in seconds for write operations.

Methods Summary

compare(other[, shortcut, rtol, atol, output])

Compare this configuration to another Config for equality.

formatHistory(name, **kwargs)

Format a configuration field's history to a human-readable format.

freeze()

Make this config, and all subconfigs, read-only.

items()

Get configurations as (field name, field value) pairs.

keys()

Get field names.

load(filename[, root])

Modify this config in place by executing the Python code in a configuration file.

loadFromStream(stream[, root, filename])

Modify this Config in place by executing the Python code in the provided stream.

loadFromString(code[, root, filename])

Modify this Config in place by executing the Python code in the provided string.

names()

Get all the field names in the config, recursively.

save(filename[, root])

Save a Python script to the named file, which, when loaded, reproduces this config.

saveToStream(outfile[, root, skipImports])

Save a configuration file to a stream, which, when loaded, reproduces this config.

saveToString([skipImports])

Return the Python script form of this configuration as an executable string.

setDefaults()

Subclass hook for computing defaults.

toDict()

Make a dictionary of field names and their values.

update(**kw)

Update values of fields specified by the keyword arguments.

validate()

Validate the Config, raising an exception if invalid.

values()

Get field values.

Attributes Documentation

contact_points

The list of contact points to try connecting for cluster discovery. (List, default ['127.0.0.1'])

dia_object_columns

List of columns to read from DiaObject, by default read all columns (List, default [])

extra_schema_file

Location of (YAML) configuration file with extra schema, definitions in this file are merged with the definitions in ‘schema_file’, extending or replacing parts of the schema. Deprecated: This field is deprecated, its value is not used. (str, default None)

history

Read-only history.

keyspace

Default keyspace for operations. (str, default 'apdb')

pandas_delay_conv

If True then combine result rows before converting to pandas. (bool, default True)

part_pix_level

Pixelization level used for partitioning index. (int, default 10)

part_pix_max_ranges

Max number of ranges in pixelization envelope (int, default 64)

part_pixelization

Pixelization used for partitioning index. (str, default 'mq3c')

Allowed values:

'htm'

HTM pixelization

'q3c'

Q3C pixelization

'mq3c'

MQ3C pixelization

'None'

Field is optional

prefix

Prefix to add to table names (str, default '')

private_ips

List of internal IP addresses for contact_points. (List, default [])

protocol_version

Cassandra protocol version to use, default is V4 (int, default 0)

query_per_spatial_part

If True then build one query per spacial partition, otherwise build single query. (bool, default False)

query_per_time_part

If True then build separate query for each time partition, otherwise build one single query. This is only used when time_partition_tables is False in schema config. (bool, default False)

ra_dec_columns

Names ra/dec columns in DiaObject table (List, default ['ra', 'decl'])

read_concurrency

Concurrency level for read operations. (int, default 500)

read_consistency

Name for consistency level of read operations, default: QUORUM, can be ONE. (str, default 'QUORUM')

read_forced_sources_months

Number of months of history to read from DiaForcedSource (int, default 12)

read_sources_months

Number of months of history to read from DiaSource (int, default 12)

read_timeout

Timeout in seconds for read operations. (float, default 120.0)

schema_file

Location of (YAML) configuration file with standard schema (str, default '${SDM_SCHEMAS_DIR}/yml/apdb.yaml')

schema_name

Name of the schema in YAML configuration file. (str, default 'ApdbSchema')

time_partition_days

Time partitoning granularity in days, this value must not be changed after database is initialized (int, default 30)

time_partition_end

Ending time for per-partion tables, in yyyy-mm-ddThh:mm:ss format, in TAI This is used only when time_partition_tables is True. (str, default '2030-01-01T00:00:00')

time_partition_start

Starting time for per-partion tables, in yyyy-mm-ddThh:mm:ss format, in TAI. This is used only when time_partition_tables is True. (str, default '2018-12-01T00:00:00')

time_partition_tables

Use per-partition tables for sources instead of partitioning by time (bool, default True)

timer

If True then print/log timing information (bool, default False)

write_consistency

Name for consistency level of write operations, default: QUORUM, can be ONE. (str, default 'QUORUM')

write_timeout

Timeout in seconds for write operations. (float, default 10.0)

Methods Documentation

compare(other, shortcut=True, rtol=1e-08, atol=1e-08, output=None)

Compare this configuration to another Config for equality.

Parameters:
otherlsst.pex.config.Config

Other Config object to compare against this config.

shortcutbool, optional

If True, return as soon as an inequality is found. Default is True.

rtolfloat, optional

Relative tolerance for floating point comparisons.

atolfloat, optional

Absolute tolerance for floating point comparisons.

outputcallable, optional

A callable that takes a string, used (possibly repeatedly) to report inequalities.

Returns:
isEqualbool

True when the two lsst.pex.config.Config instances are equal. False if there is an inequality.

Notes

Unselected targets of RegistryField fields and unselected choices of ConfigChoiceField fields are not considered by this method.

Floating point comparisons are performed by numpy.allclose.

formatHistory(name, **kwargs)

Format a configuration field’s history to a human-readable format.

Parameters:
namestr

Name of a Field in this config.

kwargs

Keyword arguments passed to lsst.pex.config.history.format.

Returns:
historystr

A string containing the formatted history.

freeze()

Make this config, and all subconfigs, read-only.

items()

Get configurations as (field name, field value) pairs.

Returns:
itemsdict_items

Iterator of tuples for each configuration. Tuple items are:

  1. Field name.

  2. Field value.

keys()

Get field names.

Returns:
namesdict_keys

List of lsst.pex.config.Field names.

See also

lsst.pex.config.Config.iterkeys
load(filename, root='config')

Modify this config in place by executing the Python code in a configuration file.

Parameters:
filenamestr

Name of the configuration file. A configuration file is Python module.

rootstr, optional

Name of the variable in file that refers to the config being overridden.

For example, the value of root is "config" and the file contains:

config.myField = 5

Then this config’s field myField is set to 5.

loadFromStream(stream, root='config', filename=None)

Modify this Config in place by executing the Python code in the provided stream.

Parameters:
streamfile-like object, str, bytes, or compiled string

Stream containing configuration override code. If this is a code object, it should be compiled with mode="exec".

rootstr, optional

Name of the variable in file that refers to the config being overridden.

For example, the value of root is "config" and the file contains:

config.myField = 5

Then this config’s field myField is set to 5.

filenamestr, optional

Name of the configuration file, or None if unknown or contained in the stream. Used for error reporting.

Notes

For backwards compatibility reasons, this method accepts strings, bytes and code objects as well as file-like objects. New code should use loadFromString instead for most of these types.

loadFromString(code, root='config', filename=None)

Modify this Config in place by executing the Python code in the provided string.

Parameters:
codestr, bytes, or compiled string

Stream containing configuration override code.

rootstr, optional

Name of the variable in file that refers to the config being overridden.

For example, the value of root is "config" and the file contains:

config.myField = 5

Then this config’s field myField is set to 5.

filenamestr, optional

Name of the configuration file, or None if unknown or contained in the stream. Used for error reporting.

names()

Get all the field names in the config, recursively.

Returns:
nameslist of str

Field names.

save(filename, root='config')

Save a Python script to the named file, which, when loaded, reproduces this config.

Parameters:
filenamestr

Desination filename of this configuration.

rootstr, optional

Name to use for the root config variable. The same value must be used when loading (see lsst.pex.config.Config.load).

saveToStream(outfile, root='config', skipImports=False)

Save a configuration file to a stream, which, when loaded, reproduces this config.

Parameters:
outfilefile-like object

Destination file object write the config into. Accepts strings not bytes.

root

Name to use for the root config variable. The same value must be used when loading (see lsst.pex.config.Config.load).

skipImportsbool, optional

If True then do not include import statements in output, this is to support human-oriented output from pipetask where additional clutter is not useful.

saveToString(skipImports=False)

Return the Python script form of this configuration as an executable string.

Parameters:
skipImportsbool, optional

If True then do not include import statements in output, this is to support human-oriented output from pipetask where additional clutter is not useful.

Returns:
codestr

A code string readable by loadFromString.

setDefaults()

Subclass hook for computing defaults.

Notes

Derived Config classes that must compute defaults rather than using the Field instances’s defaults should do so here. To correctly use inherited defaults, implementations of setDefaults must call their base class’s setDefaults.

toDict()

Make a dictionary of field names and their values.

Returns:
dict_dict

Dictionary with keys that are Field names. Values are Field values.

Notes

This method uses the toDict method of individual fields. Subclasses of Field may need to implement a toDict method for this method to work.

update(**kw)

Update values of fields specified by the keyword arguments.

Parameters:
kw

Keywords are configuration field names. Values are configuration field values.

Notes

The __at and __label keyword arguments are special internal keywords. They are used to strip out any internal steps from the history tracebacks of the config. Do not modify these keywords to subvert a Config instance’s history.

Examples

This is a config with three fields:

>>> from lsst.pex.config import Config, Field
>>> class DemoConfig(Config):
...     fieldA = Field(doc='Field A', dtype=int, default=42)
...     fieldB = Field(doc='Field B', dtype=bool, default=True)
...     fieldC = Field(doc='Field C', dtype=str, default='Hello world')
...
>>> config = DemoConfig()

These are the default values of each field:

>>> for name, value in config.iteritems():
...     print(f"{name}: {value}")
...
fieldA: 42
fieldB: True
fieldC: 'Hello world'

Using this method to update fieldA and fieldC:

>>> config.update(fieldA=13, fieldC='Updated!')

Now the values of each field are:

>>> for name, value in config.iteritems():
...     print(f"{name}: {value}")
...
fieldA: 13
fieldB: True
fieldC: 'Updated!'
validate()

Validate the Config, raising an exception if invalid.

Raises:
lsst.pex.config.FieldValidationError

Raised if verification fails.

Notes

The base class implementation performs type checks on all fields by calling their validate methods.

Complex single-field validation can be defined by deriving new Field types. For convenience, some derived lsst.pex.config.Field-types (ConfigField and ConfigChoiceField) are defined in lsst.pex.config that handle recursing into subconfigs.

Inter-field relationships should only be checked in derived Config classes after calling this method, and base validation is complete.

values()

Get field values.

Returns:
valuesdict_values

Iterator of field values.