AstraDBSettings Class

AstraDB model settings.

Settings for AstraDB connection:

• app_token: SecretStr | None - AstraDB token (Env var ASTRADB_APP_TOKEN)
• db_id: str | None - AstraDB database ID (Env var ASTRADB_DB_ID)
• region: str | None - AstraDB region (Env var ASTRADB_REGION)
• keyspace: str | None - AstraDB keyspace (Env var ASTRADB_KEYSPACE)

Note: This class is marked as 'experimental' and may change in the future.

Constructor

AstraDBSettings(_case_sensitive: bool | None = None, _nested_model_default_partial_update: bool | None = None, _env_prefix: str | None = None, _env_file: DotenvType | None = PosixPath('.'), _env_file_encoding: str | None = None, _env_ignore_empty: bool | None = None, _env_nested_delimiter: str | None = None, _env_parse_none_str: str | None = None, _env_parse_enums: bool | None = None, _cli_prog_name: str | None = None, _cli_parse_args: bool | list[str] | tuple[str, ...] | None = None, _cli_settings_source: CliSettingsSource[Any] | None = None, _cli_parse_none_str: str | None = None, _cli_hide_none_type: bool | None = None, _cli_avoid_json: bool | None = None, _cli_enforce_required: bool | None = None, _cli_use_class_docs_for_groups: bool | None = None, _cli_exit_on_error: bool | None = None, _cli_prefix: str | None = None, _cli_implicit_flags: bool | None = None, _secrets_dir: PathType | None = None, *, env_file_path: str | None = None, env_file_encoding: str = 'utf-8', app_token: SecretStr, db_id: str, region: str, keyspace: str)

Parameters

Name	Description
_case_sensitive	Default value: None
_nested_model_default_partial_update	Default value: None
_env_prefix	Default value: None
_env_file	Default value: .
_env_file_encoding	Default value: None
_env_ignore_empty	Default value: None
_env_nested_delimiter	Default value: None
_env_parse_none_str	Default value: None
_env_parse_enums	Default value: None
_cli_prog_name	Default value: None
_cli_parse_args	Default value: None
_cli_settings_source	Default value: None
_cli_parse_none_str	Default value: None
_cli_hide_none_type	Default value: None
_cli_avoid_json	Default value: None
_cli_enforce_required	Default value: None
_cli_use_class_docs_for_groups	Default value: None
_cli_exit_on_error	Default value: None
_cli_prefix	Default value: None
_cli_implicit_flags	Default value: None
_secrets_dir	Default value: None

Keyword-Only Parameters

Name	Description
env_file_path Required
env_file_encoding	Default value: utf-8
app_token Required
db_id Required
region Required
keyspace Required

Attributes

app_token

app_token: SecretStr

db_id

db_id: str

env_file_encoding

env_file_encoding: str

env_file_path

env_file_path: str | None

env_prefix

env_prefix: ClassVar[str] = 'ASTRADB_'

is_experimental

is_experimental = True

keyspace

keyspace: str

region

region: str

stage_status

stage_status = 'experimental'