id
stringlengths
7
77
text
stringlengths
0
3.4k
metadata
dict
astrapy.exceptions.MultiCallTimeoutManager.remaining_timeout_ms
Ensure the deadline, if any, is not yet in the past. If it is, raise an appropriate timeout error. If not, return either None (if no timeout) or the remaining milliseconds. For use within the multi-call method.
{ "kind": "function", "name": "remaining_timeout_ms", "path": "astrapy.exceptions.MultiCallTimeoutManager.remaining_timeout_ms", "parameters": null, "returns": [ { "name": null, "type": "int | None", "description": null } ], "gathered_types": null, "value": null, "yields": nu...
astrapy.exceptions.MultiCallTimeoutManager.remaining_timeout_info
Ensure the deadline, if any, is not yet in the past. If it is, raise an appropriate timeout error. It it is not, or there is no deadline, return a suitable TimeoutInfo for use within the multi-call method.
{ "kind": "function", "name": "remaining_timeout_info", "path": "astrapy.exceptions.MultiCallTimeoutManager.remaining_timeout_info", "parameters": null, "returns": [ { "name": null, "type": "TimeoutInfo | None", "description": null } ], "gathered_types": [ "astrapy.request_to...
astrapy.defaults
{ "kind": "module", "name": "defaults", "path": "astrapy.defaults", "parameters": null, "returns": null, "gathered_types": null, "value": null, "yields": null, "imports": { "annotations": "__future__.annotations", "logging": null, "Any": null, "cast": null, "httpx": null, "API_...
astrapy.defaults.DATA_API_ENVIRONMENT_PROD
{ "kind": "attribute", "name": "DATA_API_ENVIRONMENT_PROD", "path": "astrapy.defaults.DATA_API_ENVIRONMENT_PROD", "parameters": null, "returns": null, "gathered_types": null, "value": "DATA_API_ENVIRONMENT_PROD = 'prod'", "yields": null, "imports": null, "properties": null, "bases": null, "expor...
astrapy.defaults.DATA_API_ENVIRONMENT_DEV
{ "kind": "attribute", "name": "DATA_API_ENVIRONMENT_DEV", "path": "astrapy.defaults.DATA_API_ENVIRONMENT_DEV", "parameters": null, "returns": null, "gathered_types": null, "value": "DATA_API_ENVIRONMENT_DEV = 'dev'", "yields": null, "imports": null, "properties": null, "bases": null, "exports":...
astrapy.defaults.DATA_API_ENVIRONMENT_TEST
{ "kind": "attribute", "name": "DATA_API_ENVIRONMENT_TEST", "path": "astrapy.defaults.DATA_API_ENVIRONMENT_TEST", "parameters": null, "returns": null, "gathered_types": null, "value": "DATA_API_ENVIRONMENT_TEST = 'test'", "yields": null, "imports": null, "properties": null, "bases": null, "expor...
astrapy.defaults.DATA_API_ENVIRONMENT_DSE
{ "kind": "attribute", "name": "DATA_API_ENVIRONMENT_DSE", "path": "astrapy.defaults.DATA_API_ENVIRONMENT_DSE", "parameters": null, "returns": null, "gathered_types": null, "value": "DATA_API_ENVIRONMENT_DSE = 'dse'", "yields": null, "imports": null, "properties": null, "bases": null, "exports":...
astrapy.defaults.DATA_API_ENVIRONMENT_HCD
{ "kind": "attribute", "name": "DATA_API_ENVIRONMENT_HCD", "path": "astrapy.defaults.DATA_API_ENVIRONMENT_HCD", "parameters": null, "returns": null, "gathered_types": null, "value": "DATA_API_ENVIRONMENT_HCD = 'hcd'", "yields": null, "imports": null, "properties": null, "bases": null, "exports":...
astrapy.defaults.DATA_API_ENVIRONMENT_CASSANDRA
{ "kind": "attribute", "name": "DATA_API_ENVIRONMENT_CASSANDRA", "path": "astrapy.defaults.DATA_API_ENVIRONMENT_CASSANDRA", "parameters": null, "returns": null, "gathered_types": null, "value": "DATA_API_ENVIRONMENT_CASSANDRA = 'cassandra'", "yields": null, "imports": null, "properties": null, "ba...
astrapy.defaults.DATA_API_ENVIRONMENT_OTHER
{ "kind": "attribute", "name": "DATA_API_ENVIRONMENT_OTHER", "path": "astrapy.defaults.DATA_API_ENVIRONMENT_OTHER", "parameters": null, "returns": null, "gathered_types": null, "value": "DATA_API_ENVIRONMENT_OTHER = 'other'", "yields": null, "imports": null, "properties": null, "bases": null, "e...
astrapy.defaults.DEFAULT_ASTRA_DB_KEYSPACE
{ "kind": "attribute", "name": "DEFAULT_ASTRA_DB_KEYSPACE", "path": "astrapy.defaults.DEFAULT_ASTRA_DB_KEYSPACE", "parameters": null, "returns": null, "gathered_types": null, "value": "DEFAULT_ASTRA_DB_KEYSPACE = 'default_keyspace'", "yields": null, "imports": null, "properties": null, "bases": nu...
astrapy.defaults.API_ENDPOINT_TEMPLATE_ENV_MAP
{ "kind": "attribute", "name": "API_ENDPOINT_TEMPLATE_ENV_MAP", "path": "astrapy.defaults.API_ENDPOINT_TEMPLATE_ENV_MAP", "parameters": null, "returns": null, "gathered_types": [ "astrapy.defaults.DATA_API_ENVIRONMENT_PROD", "astrapy.defaults.DATA_API_ENVIRONMENT_DEV", "astrapy.defaults.DATA_API...
astrapy.defaults.API_PATH_ENV_MAP
{ "kind": "attribute", "name": "API_PATH_ENV_MAP", "path": "astrapy.defaults.API_PATH_ENV_MAP", "parameters": null, "returns": null, "gathered_types": [ "astrapy.defaults.DATA_API_ENVIRONMENT_DEV", "astrapy.defaults.DATA_API_ENVIRONMENT_TEST", "astrapy.defaults.DATA_API_ENVIRONMENT_DSE", "as...
astrapy.defaults.API_VERSION_ENV_MAP
{ "kind": "attribute", "name": "API_VERSION_ENV_MAP", "path": "astrapy.defaults.API_VERSION_ENV_MAP", "parameters": null, "returns": null, "gathered_types": [ "astrapy.defaults.DATA_API_ENVIRONMENT_DEV", "astrapy.defaults.DATA_API_ENVIRONMENT_TEST", "astrapy.defaults.DATA_API_ENVIRONMENT_DSE", ...
astrapy.defaults.DEFAULT_INSERT_MANY_CHUNK_SIZE
{ "kind": "attribute", "name": "DEFAULT_INSERT_MANY_CHUNK_SIZE", "path": "astrapy.defaults.DEFAULT_INSERT_MANY_CHUNK_SIZE", "parameters": null, "returns": null, "gathered_types": null, "value": "DEFAULT_INSERT_MANY_CHUNK_SIZE = 50", "yields": null, "imports": null, "properties": null, "bases": nul...
astrapy.defaults.DEFAULT_INSERT_MANY_CONCURRENCY
{ "kind": "attribute", "name": "DEFAULT_INSERT_MANY_CONCURRENCY", "path": "astrapy.defaults.DEFAULT_INSERT_MANY_CONCURRENCY", "parameters": null, "returns": null, "gathered_types": null, "value": "DEFAULT_INSERT_MANY_CONCURRENCY = 20", "yields": null, "imports": null, "properties": null, "bases": ...
astrapy.defaults.DEFAULT_BULK_WRITE_CONCURRENCY
{ "kind": "attribute", "name": "DEFAULT_BULK_WRITE_CONCURRENCY", "path": "astrapy.defaults.DEFAULT_BULK_WRITE_CONCURRENCY", "parameters": null, "returns": null, "gathered_types": null, "value": "DEFAULT_BULK_WRITE_CONCURRENCY = 10", "yields": null, "imports": null, "properties": null, "bases": nul...
astrapy.defaults.DEFAULT_REQUEST_TIMEOUT_MS
{ "kind": "attribute", "name": "DEFAULT_REQUEST_TIMEOUT_MS", "path": "astrapy.defaults.DEFAULT_REQUEST_TIMEOUT_MS", "parameters": null, "returns": null, "gathered_types": null, "value": "DEFAULT_REQUEST_TIMEOUT_MS = 30000", "yields": null, "imports": null, "properties": null, "bases": null, "exp...
astrapy.defaults.DEFAULT_DATA_API_AUTH_HEADER
{ "kind": "attribute", "name": "DEFAULT_DATA_API_AUTH_HEADER", "path": "astrapy.defaults.DEFAULT_DATA_API_AUTH_HEADER", "parameters": null, "returns": null, "gathered_types": null, "value": "DEFAULT_DATA_API_AUTH_HEADER = 'Token'", "yields": null, "imports": null, "properties": null, "bases": null...
astrapy.defaults.EMBEDDING_HEADER_AWS_ACCESS_ID
{ "kind": "attribute", "name": "EMBEDDING_HEADER_AWS_ACCESS_ID", "path": "astrapy.defaults.EMBEDDING_HEADER_AWS_ACCESS_ID", "parameters": null, "returns": null, "gathered_types": null, "value": "EMBEDDING_HEADER_AWS_ACCESS_ID = 'X-Embedding-Access-Id'", "yields": null, "imports": null, "properties":...
astrapy.defaults.EMBEDDING_HEADER_AWS_SECRET_ID
{ "kind": "attribute", "name": "EMBEDDING_HEADER_AWS_SECRET_ID", "path": "astrapy.defaults.EMBEDDING_HEADER_AWS_SECRET_ID", "parameters": null, "returns": null, "gathered_types": null, "value": "EMBEDDING_HEADER_AWS_SECRET_ID = 'X-Embedding-Secret-Id'", "yields": null, "imports": null, "properties":...
astrapy.defaults.EMBEDDING_HEADER_API_KEY
{ "kind": "attribute", "name": "EMBEDDING_HEADER_API_KEY", "path": "astrapy.defaults.EMBEDDING_HEADER_API_KEY", "parameters": null, "returns": null, "gathered_types": null, "value": "EMBEDDING_HEADER_API_KEY = 'X-Embedding-Api-Key'", "yields": null, "imports": null, "properties": null, "bases": nu...
astrapy.defaults.DEFAULT_DEV_OPS_AUTH_HEADER
{ "kind": "attribute", "name": "DEFAULT_DEV_OPS_AUTH_HEADER", "path": "astrapy.defaults.DEFAULT_DEV_OPS_AUTH_HEADER", "parameters": null, "returns": null, "gathered_types": null, "value": "DEFAULT_DEV_OPS_AUTH_HEADER = 'Authorization'", "yields": null, "imports": null, "properties": null, "bases":...
astrapy.defaults.DEFAULT_DEV_OPS_AUTH_PREFIX
{ "kind": "attribute", "name": "DEFAULT_DEV_OPS_AUTH_PREFIX", "path": "astrapy.defaults.DEFAULT_DEV_OPS_AUTH_PREFIX", "parameters": null, "returns": null, "gathered_types": null, "value": "DEFAULT_DEV_OPS_AUTH_PREFIX = 'Bearer '", "yields": null, "imports": null, "properties": null, "bases": null,...
astrapy.defaults.DEV_OPS_KEYSPACE_POLL_INTERVAL_S
{ "kind": "attribute", "name": "DEV_OPS_KEYSPACE_POLL_INTERVAL_S", "path": "astrapy.defaults.DEV_OPS_KEYSPACE_POLL_INTERVAL_S", "parameters": null, "returns": null, "gathered_types": null, "value": "DEV_OPS_KEYSPACE_POLL_INTERVAL_S = 2", "yields": null, "imports": null, "properties": null, "bases"...
astrapy.defaults.DEV_OPS_DATABASE_POLL_INTERVAL_S
{ "kind": "attribute", "name": "DEV_OPS_DATABASE_POLL_INTERVAL_S", "path": "astrapy.defaults.DEV_OPS_DATABASE_POLL_INTERVAL_S", "parameters": null, "returns": null, "gathered_types": null, "value": "DEV_OPS_DATABASE_POLL_INTERVAL_S = 15", "yields": null, "imports": null, "properties": null, "bases...
astrapy.defaults.DEV_OPS_DATABASE_STATUS_MAINTENANCE
{ "kind": "attribute", "name": "DEV_OPS_DATABASE_STATUS_MAINTENANCE", "path": "astrapy.defaults.DEV_OPS_DATABASE_STATUS_MAINTENANCE", "parameters": null, "returns": null, "gathered_types": null, "value": "DEV_OPS_DATABASE_STATUS_MAINTENANCE = 'MAINTENANCE'", "yields": null, "imports": null, "propert...
astrapy.defaults.DEV_OPS_DATABASE_STATUS_ACTIVE
{ "kind": "attribute", "name": "DEV_OPS_DATABASE_STATUS_ACTIVE", "path": "astrapy.defaults.DEV_OPS_DATABASE_STATUS_ACTIVE", "parameters": null, "returns": null, "gathered_types": null, "value": "DEV_OPS_DATABASE_STATUS_ACTIVE = 'ACTIVE'", "yields": null, "imports": null, "properties": null, "bases...
astrapy.defaults.DEV_OPS_DATABASE_STATUS_PENDING
{ "kind": "attribute", "name": "DEV_OPS_DATABASE_STATUS_PENDING", "path": "astrapy.defaults.DEV_OPS_DATABASE_STATUS_PENDING", "parameters": null, "returns": null, "gathered_types": null, "value": "DEV_OPS_DATABASE_STATUS_PENDING = 'PENDING'", "yields": null, "imports": null, "properties": null, "b...
astrapy.defaults.DEV_OPS_DATABASE_STATUS_INITIALIZING
{ "kind": "attribute", "name": "DEV_OPS_DATABASE_STATUS_INITIALIZING", "path": "astrapy.defaults.DEV_OPS_DATABASE_STATUS_INITIALIZING", "parameters": null, "returns": null, "gathered_types": null, "value": "DEV_OPS_DATABASE_STATUS_INITIALIZING = 'INITIALIZING'", "yields": null, "imports": null, "pro...
astrapy.defaults.DEV_OPS_DATABASE_STATUS_ERROR
{ "kind": "attribute", "name": "DEV_OPS_DATABASE_STATUS_ERROR", "path": "astrapy.defaults.DEV_OPS_DATABASE_STATUS_ERROR", "parameters": null, "returns": null, "gathered_types": null, "value": "DEV_OPS_DATABASE_STATUS_ERROR = 'ERROR'", "yields": null, "imports": null, "properties": null, "bases": n...
astrapy.defaults.DEV_OPS_DATABASE_STATUS_TERMINATING
{ "kind": "attribute", "name": "DEV_OPS_DATABASE_STATUS_TERMINATING", "path": "astrapy.defaults.DEV_OPS_DATABASE_STATUS_TERMINATING", "parameters": null, "returns": null, "gathered_types": null, "value": "DEV_OPS_DATABASE_STATUS_TERMINATING = 'TERMINATING'", "yields": null, "imports": null, "propert...
astrapy.defaults.DEV_OPS_URL_ENV_MAP
{ "kind": "attribute", "name": "DEV_OPS_URL_ENV_MAP", "path": "astrapy.defaults.DEV_OPS_URL_ENV_MAP", "parameters": null, "returns": null, "gathered_types": [ "astrapy.defaults.DATA_API_ENVIRONMENT_PROD", "astrapy.defaults.DATA_API_ENVIRONMENT_DEV", "astrapy.defaults.DATA_API_ENVIRONMENT_TEST" ...
astrapy.defaults.DEV_OPS_VERSION_ENV_MAP
{ "kind": "attribute", "name": "DEV_OPS_VERSION_ENV_MAP", "path": "astrapy.defaults.DEV_OPS_VERSION_ENV_MAP", "parameters": null, "returns": null, "gathered_types": [ "astrapy.defaults.DATA_API_ENVIRONMENT_PROD", "astrapy.defaults.DATA_API_ENVIRONMENT_DEV", "astrapy.defaults.DATA_API_ENVIRONMENT...
astrapy.defaults.DEV_OPS_RESPONSE_HTTP_ACCEPTED
{ "kind": "attribute", "name": "DEV_OPS_RESPONSE_HTTP_ACCEPTED", "path": "astrapy.defaults.DEV_OPS_RESPONSE_HTTP_ACCEPTED", "parameters": null, "returns": null, "gathered_types": null, "value": "DEV_OPS_RESPONSE_HTTP_ACCEPTED = 202", "yields": null, "imports": null, "properties": null, "bases": nu...
astrapy.defaults.DEV_OPS_RESPONSE_HTTP_CREATED
{ "kind": "attribute", "name": "DEV_OPS_RESPONSE_HTTP_CREATED", "path": "astrapy.defaults.DEV_OPS_RESPONSE_HTTP_CREATED", "parameters": null, "returns": null, "gathered_types": null, "value": "DEV_OPS_RESPONSE_HTTP_CREATED = 201", "yields": null, "imports": null, "properties": null, "bases": null,...
astrapy.defaults.DEV_OPS_DEFAULT_DATABASES_PAGE_SIZE
{ "kind": "attribute", "name": "DEV_OPS_DEFAULT_DATABASES_PAGE_SIZE", "path": "astrapy.defaults.DEV_OPS_DEFAULT_DATABASES_PAGE_SIZE", "parameters": null, "returns": null, "gathered_types": null, "value": "DEV_OPS_DEFAULT_DATABASES_PAGE_SIZE = 25", "yields": null, "imports": null, "properties": null,...
astrapy.defaults.SECRETS_REDACT_ENDING
{ "kind": "attribute", "name": "SECRETS_REDACT_ENDING", "path": "astrapy.defaults.SECRETS_REDACT_ENDING", "parameters": null, "returns": null, "gathered_types": null, "value": "SECRETS_REDACT_ENDING = '...'", "yields": null, "imports": null, "properties": null, "bases": null, "exports": null, ...
astrapy.defaults.SECRETS_REDACT_CHAR
{ "kind": "attribute", "name": "SECRETS_REDACT_CHAR", "path": "astrapy.defaults.SECRETS_REDACT_CHAR", "parameters": null, "returns": null, "gathered_types": null, "value": "SECRETS_REDACT_CHAR = '*'", "yields": null, "imports": null, "properties": null, "bases": null, "exports": null, "example...
astrapy.defaults.SECRETS_REDACT_ENDING_LENGTH
{ "kind": "attribute", "name": "SECRETS_REDACT_ENDING_LENGTH", "path": "astrapy.defaults.SECRETS_REDACT_ENDING_LENGTH", "parameters": null, "returns": null, "gathered_types": null, "value": "SECRETS_REDACT_ENDING_LENGTH = 3", "yields": null, "imports": null, "properties": null, "bases": null, "e...
astrapy.defaults.HEADER_REDACT_PLACEHOLDER
{ "kind": "attribute", "name": "HEADER_REDACT_PLACEHOLDER", "path": "astrapy.defaults.HEADER_REDACT_PLACEHOLDER", "parameters": null, "returns": null, "gathered_types": null, "value": "HEADER_REDACT_PLACEHOLDER = '***'", "yields": null, "imports": null, "properties": null, "bases": null, "export...
astrapy.defaults.DEFAULT_REDACTED_HEADER_NAMES
{ "kind": "attribute", "name": "DEFAULT_REDACTED_HEADER_NAMES", "path": "astrapy.defaults.DEFAULT_REDACTED_HEADER_NAMES", "parameters": null, "returns": null, "gathered_types": [ "astrapy.defaults.EMBEDDING_HEADER_API_KEY", "astrapy.defaults.EMBEDDING_HEADER_AWS_SECRET_ID", "astrapy.defaults.DEF...
astrapy.defaults.NAMESPACE_DEPRECATION_NOTICE_METHOD
{ "kind": "attribute", "name": "NAMESPACE_DEPRECATION_NOTICE_METHOD", "path": "astrapy.defaults.NAMESPACE_DEPRECATION_NOTICE_METHOD", "parameters": null, "returns": null, "gathered_types": null, "value": "NAMESPACE_DEPRECATION_NOTICE_METHOD = \"The term 'namespace' is being replaced by 'keyspace' througho...
astrapy.defaults.NAMESPACE_DEPRECATION_NOTICE_UPDATEDBNS_SUBJECT
{ "kind": "attribute", "name": "NAMESPACE_DEPRECATION_NOTICE_UPDATEDBNS_SUBJECT", "path": "astrapy.defaults.NAMESPACE_DEPRECATION_NOTICE_UPDATEDBNS_SUBJECT", "parameters": null, "returns": null, "gathered_types": null, "value": "NAMESPACE_DEPRECATION_NOTICE_UPDATEDBNS_SUBJECT = 'Parameter `update_db_names...
astrapy.defaults.NAMESPACE_DEPRECATION_NOTICE_UPDATEDBNS_DETAILS
{ "kind": "attribute", "name": "NAMESPACE_DEPRECATION_NOTICE_UPDATEDBNS_DETAILS", "path": "astrapy.defaults.NAMESPACE_DEPRECATION_NOTICE_UPDATEDBNS_DETAILS", "parameters": null, "returns": null, "gathered_types": null, "value": "NAMESPACE_DEPRECATION_NOTICE_UPDATEDBNS_DETAILS = 'Please replace the paramet...
astrapy.defaults.NAMESPACE_DEPRECATION_NOTICE_NS_SUBJECT
{ "kind": "attribute", "name": "NAMESPACE_DEPRECATION_NOTICE_NS_SUBJECT", "path": "astrapy.defaults.NAMESPACE_DEPRECATION_NOTICE_NS_SUBJECT", "parameters": null, "returns": null, "gathered_types": null, "value": "NAMESPACE_DEPRECATION_NOTICE_NS_SUBJECT = 'Parameter `namespace`'", "yields": null, "impo...
astrapy.defaults.NAMESPACE_DEPRECATION_NOTICE_NS_DETAILS
{ "kind": "attribute", "name": "NAMESPACE_DEPRECATION_NOTICE_NS_DETAILS", "path": "astrapy.defaults.NAMESPACE_DEPRECATION_NOTICE_NS_DETAILS", "parameters": null, "returns": null, "gathered_types": null, "value": "NAMESPACE_DEPRECATION_NOTICE_NS_DETAILS = 'Please replace the parameter with `keyspace`. See ...
astrapy.defaults.SET_CALLER_DEPRECATION_NOTICE
{ "kind": "attribute", "name": "SET_CALLER_DEPRECATION_NOTICE", "path": "astrapy.defaults.SET_CALLER_DEPRECATION_NOTICE", "parameters": null, "returns": null, "gathered_types": null, "value": "SET_CALLER_DEPRECATION_NOTICE = 'Please provide the caller(s) at constructor time through the `callers` list para...
astrapy.defaults.CALLER_NAME_VERSION_DEPRECATION_NOTICE_DETAILS
{ "kind": "attribute", "name": "CALLER_NAME_VERSION_DEPRECATION_NOTICE_DETAILS", "path": "astrapy.defaults.CALLER_NAME_VERSION_DEPRECATION_NOTICE_DETAILS", "parameters": null, "returns": null, "gathered_types": null, "value": "CALLER_NAME_VERSION_DEPRECATION_NOTICE_DETAILS = \"Please pass any caller ident...
astrapy.ids
{ "kind": "module", "name": "ids", "path": "astrapy.ids", "parameters": null, "returns": null, "gathered_types": null, "value": null, "yields": null, "imports": { "annotations": "__future__.annotations", "logging": null, "Any": null, "cast": null, "httpx": null, "API_RESPONSE":...
astrapy.user_agents
{ "kind": "module", "name": "user_agents", "path": "astrapy.user_agents", "parameters": null, "returns": null, "gathered_types": null, "value": null, "yields": null, "imports": { "annotations": "__future__.annotations", "logging": null, "Any": null, "cast": null, "httpx": null, ...
astrapy.user_agents.detect_astrapy_user_agent
{ "kind": "function", "name": "detect_astrapy_user_agent", "path": "astrapy.user_agents.detect_astrapy_user_agent", "parameters": null, "returns": [ { "name": null, "type": "CallerType", "description": null } ], "gathered_types": [ "astrapy.constants.CallerType" ], "value...
astrapy.user_agents.compose_user_agent_string
{ "kind": "function", "name": "compose_user_agent_string", "path": "astrapy.user_agents.compose_user_agent_string", "parameters": [ { "name": "caller_name", "type": "str | None", "description": null, "default": null, "value": null }, { "name": "caller_version", ...
astrapy.user_agents.compose_full_user_agent
{ "kind": "function", "name": "compose_full_user_agent", "path": "astrapy.user_agents.compose_full_user_agent", "parameters": [ { "name": "callers", "type": "Sequence[CallerType]", "description": null, "default": null, "value": null } ], "returns": [ { "name":...
astrapy.api_commander
{ "kind": "module", "name": "api_commander", "path": "astrapy.api_commander", "parameters": null, "returns": null, "gathered_types": null, "value": null, "yields": null, "imports": { "annotations": "__future__.annotations", "logging": "logging", "Any": "typing.Any", "cast": "typing.cas...
astrapy.api_commander.user_agent_astrapy
{ "kind": "attribute", "name": "user_agent_astrapy", "path": "astrapy.api_commander.user_agent_astrapy", "parameters": null, "returns": null, "gathered_types": null, "value": "user_agent_astrapy = detect_astrapy_user_agent()", "yields": null, "imports": null, "properties": null, "bases": null, "...
astrapy.api_commander.logger
{ "kind": "attribute", "name": "logger", "path": "astrapy.api_commander.logger", "parameters": null, "returns": null, "gathered_types": [ "__name__" ], "value": "logger = logging.getLogger(__name__)", "yields": null, "imports": null, "properties": null, "bases": null, "exports": null, "e...
astrapy.api_commander.APICommander
{ "kind": "class", "name": "APICommander", "path": "astrapy.api_commander.APICommander", "parameters": [ { "name": "api_endpoint", "type": "str", "description": null, "default": null, "value": null }, { "name": "path", "type": "str", "description": nul...
astrapy.api_commander.APICommander.client
{ "kind": "attribute", "name": "client", "path": "astrapy.api_commander.APICommander.client", "parameters": null, "returns": null, "gathered_types": [ "Client" ], "value": "client = httpx.Client()", "yields": null, "imports": null, "properties": null, "bases": null, "exports": null, "exa...
astrapy.api_commander.APICommander.async_client
{ "kind": "attribute", "name": "async_client", "path": "astrapy.api_commander.APICommander.async_client", "parameters": null, "returns": null, "gathered_types": [ "AsyncClient" ], "value": "async_client = httpx.AsyncClient()", "yields": null, "imports": null, "properties": null, "bases": nul...
astrapy.api_commander.APICommander.api_endpoint
{ "kind": "attribute", "name": "api_endpoint", "path": "astrapy.api_commander.APICommander.api_endpoint", "parameters": null, "returns": null, "gathered_types": null, "value": "api_endpoint = api_endpoint.rstrip('/')", "yields": null, "imports": null, "properties": null, "bases": null, "exports"...
astrapy.api_commander.APICommander.path
{ "kind": "attribute", "name": "path", "path": "astrapy.api_commander.APICommander.path", "parameters": null, "returns": null, "gathered_types": null, "value": "path = path.lstrip('/')", "yields": null, "imports": null, "properties": null, "bases": null, "exports": null, "example": null, "re...
astrapy.api_commander.APICommander.headers
{ "kind": "attribute", "name": "headers", "path": "astrapy.api_commander.APICommander.headers", "parameters": null, "returns": null, "gathered_types": null, "value": "headers = headers", "yields": null, "imports": null, "properties": null, "bases": null, "exports": null, "example": null, "re...
astrapy.api_commander.APICommander.callers
{ "kind": "attribute", "name": "callers", "path": "astrapy.api_commander.APICommander.callers", "parameters": null, "returns": null, "gathered_types": null, "value": "callers = callers", "yields": null, "imports": null, "properties": null, "bases": null, "exports": null, "example": null, "re...
astrapy.api_commander.APICommander.redacted_header_names
{ "kind": "attribute", "name": "redacted_header_names", "path": "astrapy.api_commander.APICommander.redacted_header_names", "parameters": null, "returns": null, "gathered_types": null, "value": "redacted_header_names = set(redacted_header_names)", "yields": null, "imports": null, "properties": null,...
astrapy.api_commander.APICommander.dev_ops_api
{ "kind": "attribute", "name": "dev_ops_api", "path": "astrapy.api_commander.APICommander.dev_ops_api", "parameters": null, "returns": null, "gathered_types": null, "value": "dev_ops_api = dev_ops_api", "yields": null, "imports": null, "properties": null, "bases": null, "exports": null, "examp...
astrapy.api_commander.APICommander.caller_header
{ "kind": "attribute", "name": "caller_header", "path": "astrapy.api_commander.APICommander.caller_header", "parameters": null, "returns": null, "gathered_types": null, "value": "caller_header: dict[str, str] = {'User-Agent': full_user_agent_string} if full_user_agent_string else {}", "yields": null, ...
astrapy.api_commander.APICommander.full_headers
{ "kind": "attribute", "name": "full_headers", "path": "astrapy.api_commander.APICommander.full_headers", "parameters": null, "returns": null, "gathered_types": null, "value": "full_headers: dict[str, str] = {None: {k: vfor (k, v) in self.headers.items() if v is not None}, None: self.caller_header, None: ...
astrapy.api_commander.APICommander.full_path
{ "kind": "attribute", "name": "full_path", "path": "astrapy.api_commander.APICommander.full_path", "parameters": null, "returns": null, "gathered_types": null, "value": "full_path = '/'.join([self.api_endpoint, self.path]).rstrip('/')", "yields": null, "imports": null, "properties": null, "bases"...
astrapy.api_commander.APICommander.raw_request
{ "kind": "function", "name": "raw_request", "path": "astrapy.api_commander.APICommander.raw_request", "parameters": [ { "name": "http_method", "type": "str", "description": null, "default": "HttpMethod.POST", "value": null }, { "name": "payload", "type": "d...
astrapy.api_commander.APICommander.async_raw_request
{ "kind": "function", "name": "async_raw_request", "path": "astrapy.api_commander.APICommander.async_raw_request", "parameters": [ { "name": "http_method", "type": "str", "description": null, "default": "HttpMethod.POST", "value": null }, { "name": "payload", ...
astrapy.api_commander.APICommander.request
{ "kind": "function", "name": "request", "path": "astrapy.api_commander.APICommander.request", "parameters": [ { "name": "http_method", "type": "str", "description": null, "default": "HttpMethod.POST", "value": null }, { "name": "payload", "type": "dict[str,...
astrapy.api_commander.APICommander.async_request
{ "kind": "function", "name": "async_request", "path": "astrapy.api_commander.APICommander.async_request", "parameters": [ { "name": "http_method", "type": "str", "description": null, "default": "HttpMethod.POST", "value": null }, { "name": "payload", "type"...
astrapy.info
{ "kind": "module", "name": "info", "path": "astrapy.info", "parameters": null, "returns": null, "gathered_types": null, "value": null, "yields": null, "imports": { "annotations": "__future__.annotations", "logging": null, "Any": "typing.Any", "cast": null, "httpx": null, "API_...
astrapy.info.DatabaseInfo
Represents the identifying information for a database, including the region the connection is established to.
{ "kind": "class", "name": "DatabaseInfo", "path": "astrapy.info.DatabaseInfo", "parameters": [ { "name": "id", "type": "str", "description": null, "default": null, "value": null }, { "name": "region", "type": "str", "description": null, "default...
astrapy.info.DatabaseInfo.id
{ "kind": "attribute", "name": "id", "path": "astrapy.info.DatabaseInfo.id", "parameters": null, "returns": null, "gathered_types": null, "value": "id: str", "yields": null, "imports": null, "properties": null, "bases": null, "exports": null, "example": null, "references": null, "note": nu...
astrapy.info.DatabaseInfo.region
{ "kind": "attribute", "name": "region", "path": "astrapy.info.DatabaseInfo.region", "parameters": null, "returns": null, "gathered_types": null, "value": "region: str", "yields": null, "imports": null, "properties": null, "bases": null, "exports": null, "example": null, "references": null, ...
astrapy.info.DatabaseInfo.keyspace
{ "kind": "attribute", "name": "keyspace", "path": "astrapy.info.DatabaseInfo.keyspace", "parameters": null, "returns": null, "gathered_types": null, "value": "keyspace: str | None", "yields": null, "imports": null, "properties": null, "bases": null, "exports": null, "example": null, "refere...
astrapy.info.DatabaseInfo.namespace
{ "kind": "attribute", "name": "namespace", "path": "astrapy.info.DatabaseInfo.namespace", "parameters": null, "returns": null, "gathered_types": null, "value": "namespace: str | None", "yields": null, "imports": null, "properties": null, "bases": null, "exports": null, "example": null, "ref...
astrapy.info.DatabaseInfo.name
{ "kind": "attribute", "name": "name", "path": "astrapy.info.DatabaseInfo.name", "parameters": null, "returns": null, "gathered_types": null, "value": "name: str", "yields": null, "imports": null, "properties": null, "bases": null, "exports": null, "example": null, "references": null, "not...
astrapy.info.DatabaseInfo.environment
{ "kind": "attribute", "name": "environment", "path": "astrapy.info.DatabaseInfo.environment", "parameters": null, "returns": null, "gathered_types": null, "value": "environment: str", "yields": null, "imports": null, "properties": null, "bases": null, "exports": null, "example": null, "refe...
astrapy.info.DatabaseInfo.raw_info
{ "kind": "attribute", "name": "raw_info", "path": "astrapy.info.DatabaseInfo.raw_info", "parameters": null, "returns": null, "gathered_types": null, "value": "raw_info: dict[str, Any] | None", "yields": null, "imports": null, "properties": null, "bases": null, "exports": null, "example": null...
astrapy.info.AdminDatabaseInfo
Represents the full response from the DevOps API about a database info. Most attributes just contain the corresponding part of the raw response: for this reason, please consult the DevOps API documentation for details.
{ "kind": "class", "name": "AdminDatabaseInfo", "path": "astrapy.info.AdminDatabaseInfo", "parameters": [ { "name": "info", "type": "DatabaseInfo", "description": null, "default": null, "value": null }, { "name": "available_actions", "type": "list[str] | Non...
astrapy.info.AdminDatabaseInfo.info
{ "kind": "attribute", "name": "info", "path": "astrapy.info.AdminDatabaseInfo.info", "parameters": null, "returns": null, "gathered_types": [ "astrapy.info.DatabaseInfo" ], "value": "info: DatabaseInfo", "yields": null, "imports": null, "properties": null, "bases": null, "exports": null, ...
astrapy.info.AdminDatabaseInfo.available_actions
{ "kind": "attribute", "name": "available_actions", "path": "astrapy.info.AdminDatabaseInfo.available_actions", "parameters": null, "returns": null, "gathered_types": null, "value": "available_actions: list[str] | None", "yields": null, "imports": null, "properties": null, "bases": null, "export...
astrapy.info.AdminDatabaseInfo.cost
{ "kind": "attribute", "name": "cost", "path": "astrapy.info.AdminDatabaseInfo.cost", "parameters": null, "returns": null, "gathered_types": null, "value": "cost: dict[str, Any]", "yields": null, "imports": null, "properties": null, "bases": null, "exports": null, "example": null, "reference...
astrapy.info.AdminDatabaseInfo.cqlsh_url
{ "kind": "attribute", "name": "cqlsh_url", "path": "astrapy.info.AdminDatabaseInfo.cqlsh_url", "parameters": null, "returns": null, "gathered_types": null, "value": "cqlsh_url: str", "yields": null, "imports": null, "properties": null, "bases": null, "exports": null, "example": null, "refer...
astrapy.info.AdminDatabaseInfo.creation_time
{ "kind": "attribute", "name": "creation_time", "path": "astrapy.info.AdminDatabaseInfo.creation_time", "parameters": null, "returns": null, "gathered_types": null, "value": "creation_time: str", "yields": null, "imports": null, "properties": null, "bases": null, "exports": null, "example": nu...
astrapy.info.AdminDatabaseInfo.data_endpoint_url
{ "kind": "attribute", "name": "data_endpoint_url", "path": "astrapy.info.AdminDatabaseInfo.data_endpoint_url", "parameters": null, "returns": null, "gathered_types": null, "value": "data_endpoint_url: str", "yields": null, "imports": null, "properties": null, "bases": null, "exports": null, "...
astrapy.info.AdminDatabaseInfo.grafana_url
{ "kind": "attribute", "name": "grafana_url", "path": "astrapy.info.AdminDatabaseInfo.grafana_url", "parameters": null, "returns": null, "gathered_types": null, "value": "grafana_url: str", "yields": null, "imports": null, "properties": null, "bases": null, "exports": null, "example": null, ...
astrapy.info.AdminDatabaseInfo.graphql_url
{ "kind": "attribute", "name": "graphql_url", "path": "astrapy.info.AdminDatabaseInfo.graphql_url", "parameters": null, "returns": null, "gathered_types": null, "value": "graphql_url: str", "yields": null, "imports": null, "properties": null, "bases": null, "exports": null, "example": null, ...
astrapy.info.AdminDatabaseInfo.id
{ "kind": "attribute", "name": "id", "path": "astrapy.info.AdminDatabaseInfo.id", "parameters": null, "returns": null, "gathered_types": null, "value": "id: str", "yields": null, "imports": null, "properties": null, "bases": null, "exports": null, "example": null, "references": null, "note...
astrapy.info.AdminDatabaseInfo.last_usage_time
{ "kind": "attribute", "name": "last_usage_time", "path": "astrapy.info.AdminDatabaseInfo.last_usage_time", "parameters": null, "returns": null, "gathered_types": null, "value": "last_usage_time: str", "yields": null, "imports": null, "properties": null, "bases": null, "exports": null, "exampl...
astrapy.info.AdminDatabaseInfo.metrics
{ "kind": "attribute", "name": "metrics", "path": "astrapy.info.AdminDatabaseInfo.metrics", "parameters": null, "returns": null, "gathered_types": null, "value": "metrics: dict[str, Any]", "yields": null, "imports": null, "properties": null, "bases": null, "exports": null, "example": null, "...
astrapy.info.AdminDatabaseInfo.observed_status
{ "kind": "attribute", "name": "observed_status", "path": "astrapy.info.AdminDatabaseInfo.observed_status", "parameters": null, "returns": null, "gathered_types": null, "value": "observed_status: str", "yields": null, "imports": null, "properties": null, "bases": null, "exports": null, "exampl...
astrapy.info.AdminDatabaseInfo.org_id
{ "kind": "attribute", "name": "org_id", "path": "astrapy.info.AdminDatabaseInfo.org_id", "parameters": null, "returns": null, "gathered_types": null, "value": "org_id: str", "yields": null, "imports": null, "properties": null, "bases": null, "exports": null, "example": null, "references": n...
astrapy.info.AdminDatabaseInfo.owner_id
{ "kind": "attribute", "name": "owner_id", "path": "astrapy.info.AdminDatabaseInfo.owner_id", "parameters": null, "returns": null, "gathered_types": null, "value": "owner_id: str", "yields": null, "imports": null, "properties": null, "bases": null, "exports": null, "example": null, "referenc...
astrapy.info.AdminDatabaseInfo.status
{ "kind": "attribute", "name": "status", "path": "astrapy.info.AdminDatabaseInfo.status", "parameters": null, "returns": null, "gathered_types": null, "value": "status: str", "yields": null, "imports": null, "properties": null, "bases": null, "exports": null, "example": null, "references": n...
astrapy.info.AdminDatabaseInfo.storage
{ "kind": "attribute", "name": "storage", "path": "astrapy.info.AdminDatabaseInfo.storage", "parameters": null, "returns": null, "gathered_types": null, "value": "storage: dict[str, Any]", "yields": null, "imports": null, "properties": null, "bases": null, "exports": null, "example": null, "...
astrapy.info.AdminDatabaseInfo.termination_time
{ "kind": "attribute", "name": "termination_time", "path": "astrapy.info.AdminDatabaseInfo.termination_time", "parameters": null, "returns": null, "gathered_types": null, "value": "termination_time: str", "yields": null, "imports": null, "properties": null, "bases": null, "exports": null, "exa...