id stringlengths 7 77 | text stringlengths 0 3.4k | metadata dict |
|---|---|---|
astrapy.collection.AsyncCollection.update_many | Apply an update operations to all documents matching a condition,
optionally inserting one documents in absence of matches. | {
"kind": "function",
"name": "update_many",
"path": "astrapy.collection.AsyncCollection.update_many",
"parameters": [
{
"name": "filter",
"type": "FilterType",
"description": "a predicate expressed as a dictionary according to the\nData API filter syntax. Examples are:\n {}\n {\"nam... |
astrapy.collection.AsyncCollection.find_one_and_delete | Find a document in the collection and delete it. The deleted document,
however, is the return value of the method. | {
"kind": "function",
"name": "find_one_and_delete",
"path": "astrapy.collection.AsyncCollection.find_one_and_delete",
"parameters": [
{
"name": "filter",
"type": "FilterType",
"description": "a predicate expressed as a dictionary according to the\nData API filter syntax. Examples are:\n ... |
astrapy.collection.AsyncCollection.delete_one | Delete one document matching a provided filter.
This method never deletes more than a single document, regardless
of the number of matches to the provided filters. | {
"kind": "function",
"name": "delete_one",
"path": "astrapy.collection.AsyncCollection.delete_one",
"parameters": [
{
"name": "filter",
"type": "FilterType",
"description": "a predicate expressed as a dictionary according to the\nData API filter syntax. Examples are:\n {}\n {\"name\... |
astrapy.collection.AsyncCollection.delete_many | Delete all documents matching a provided filter. | {
"kind": "function",
"name": "delete_many",
"path": "astrapy.collection.AsyncCollection.delete_many",
"parameters": [
{
"name": "filter",
"type": "FilterType",
"description": "a predicate expressed as a dictionary according to the\nData API filter syntax. Examples are:\n {}\n {\"nam... |
astrapy.collection.AsyncCollection.delete_all | Delete all documents in a collection. | {
"kind": "function",
"name": "delete_all",
"path": "astrapy.collection.AsyncCollection.delete_all",
"parameters": [
{
"name": "max_time_ms",
"type": "int | None",
"description": "a timeout, in milliseconds, for the underlying HTTP request.\nIf not passed, the collection-level setting is u... |
astrapy.collection.AsyncCollection.bulk_write | Execute an arbitrary amount of operations such as inserts, updates, deletes
either sequentially or concurrently.
This method does not execute atomically, i.e. individual operations are
each performed in the same way as the corresponding collection method,
and each one is a different and unrelated database mutation. | {
"kind": "function",
"name": "bulk_write",
"path": "astrapy.collection.AsyncCollection.bulk_write",
"parameters": [
{
"name": "requests",
"type": "Iterable[AsyncBaseOperation]",
"description": "an iterable over concrete subclasses of `BaseOperation`,\nsuch as `AsyncInsertMany` or `AsyncRe... |
astrapy.collection.AsyncCollection.drop | Drop the collection, i.e. delete it from the database along with
all the documents it contains. | {
"kind": "function",
"name": "drop",
"path": "astrapy.collection.AsyncCollection.drop",
"parameters": [
{
"name": "max_time_ms",
"type": "int | None",
"description": "a timeout, in milliseconds, for the underlying HTTP request.\nIf not passed, the collection-level setting is used instead.... |
astrapy.collection.AsyncCollection.command | Send a POST request to the Data API for this collection with
an arbitrary, caller-provided payload. | {
"kind": "function",
"name": "command",
"path": "astrapy.collection.AsyncCollection.command",
"parameters": [
{
"name": "body",
"type": "dict[str, Any]",
"description": "a JSON-serializable dictionary, the payload of the request.",
"default": null,
"value": null
},
{
... |
astrapy.exceptions | {
"kind": "module",
"name": "exceptions",
"path": "astrapy.exceptions",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": null,
"yields": null,
"imports": {
"annotations": "__future__.annotations",
"logging": null,
"Any": "typing.Any",
"cast": null,
"httpx": "ht... | |
astrapy.exceptions.DevOpsAPIException | An exception specific to issuing requests to the DevOps API. | {
"kind": "class",
"name": "DevOpsAPIException",
"path": "astrapy.exceptions.DevOpsAPIException",
"parameters": [
{
"name": "text",
"type": "str",
"description": null,
"default": "''",
"value": null
}
],
"returns": null,
"gathered_types": [
"ValueError"
],
"va... |
astrapy.exceptions.DevOpsAPIHttpException | A request to the DevOps API resulted in an HTTP 4xx or 5xx response.
Though the DevOps API seldom enriches such errors with a response text,
this class acts as the DevOps counterpart to DataAPIHttpException
to facilitate a symmetryc handling of errors at application lebel. | {
"kind": "class",
"name": "DevOpsAPIHttpException",
"path": "astrapy.exceptions.DevOpsAPIHttpException",
"parameters": [
{
"name": "text",
"type": "str | None",
"description": null,
"default": null,
"value": null
},
{
"name": "httpx_error",
"type": "httpx.H... |
astrapy.exceptions.DevOpsAPIHttpException.text | {
"kind": "attribute",
"name": "text",
"path": "astrapy.exceptions.DevOpsAPIHttpException.text",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "text: str | None = text",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null... | |
astrapy.exceptions.DevOpsAPIHttpException.error_descriptors | {
"kind": "attribute",
"name": "error_descriptors",
"path": "astrapy.exceptions.DevOpsAPIHttpException.error_descriptors",
"parameters": null,
"returns": null,
"gathered_types": [
"DevOpsAPIErrorDescriptor"
],
"value": "error_descriptors: list[DevOpsAPIErrorDescriptor] = error_descriptors",
"yield... | |
astrapy.exceptions.DevOpsAPIHttpException.httpx_error | {
"kind": "attribute",
"name": "httpx_error",
"path": "astrapy.exceptions.DevOpsAPIHttpException.httpx_error",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "httpx_error = httpx_error",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
... | |
astrapy.exceptions.DevOpsAPIHttpException.from_httpx_error | Parse a httpx status error into this exception. | {
"kind": "function",
"name": "from_httpx_error",
"path": "astrapy.exceptions.DevOpsAPIHttpException.from_httpx_error",
"parameters": [
{
"name": "cls",
"type": null,
"description": null,
"default": null,
"value": null
},
{
"name": "httpx_error",
"type": "ht... |
astrapy.exceptions.DevOpsAPITimeoutException | A DevOps API operation timed out. | {
"kind": "class",
"name": "DevOpsAPITimeoutException",
"path": "astrapy.exceptions.DevOpsAPITimeoutException",
"parameters": [
{
"name": "text",
"type": "str",
"description": null,
"default": null,
"value": null
},
{
"name": "timeout_type",
"type": "str",
... |
astrapy.exceptions.DevOpsAPITimeoutException.text | {
"kind": "attribute",
"name": "text",
"path": "astrapy.exceptions.DevOpsAPITimeoutException.text",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "text: str = text",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
... | |
astrapy.exceptions.DevOpsAPITimeoutException.timeout_type | {
"kind": "attribute",
"name": "timeout_type",
"path": "astrapy.exceptions.DevOpsAPITimeoutException.timeout_type",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "timeout_type: str = timeout_type",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"expor... | |
astrapy.exceptions.DevOpsAPITimeoutException.endpoint | {
"kind": "attribute",
"name": "endpoint",
"path": "astrapy.exceptions.DevOpsAPITimeoutException.endpoint",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "endpoint: str | None = endpoint",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null... | |
astrapy.exceptions.DevOpsAPITimeoutException.raw_payload | {
"kind": "attribute",
"name": "raw_payload",
"path": "astrapy.exceptions.DevOpsAPITimeoutException.raw_payload",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "raw_payload: str | None = raw_payload",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"ex... | |
astrapy.exceptions.DevOpsAPIErrorDescriptor | An object representing a single error returned from the DevOps API,
typically with an error code and a text message.
A single response from the Devops API may return zero, one or more of these. | {
"kind": "class",
"name": "DevOpsAPIErrorDescriptor",
"path": "astrapy.exceptions.DevOpsAPIErrorDescriptor",
"parameters": [
{
"name": "error_dict",
"type": "dict[str, Any]",
"description": null,
"default": null,
"value": null
}
],
"returns": null,
"gathered_types": ... |
astrapy.exceptions.DevOpsAPIErrorDescriptor.id | {
"kind": "attribute",
"name": "id",
"path": "astrapy.exceptions.DevOpsAPIErrorDescriptor.id",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "id: int | None = error_dict.get('ID')",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"ex... | |
astrapy.exceptions.DevOpsAPIErrorDescriptor.message | {
"kind": "attribute",
"name": "message",
"path": "astrapy.exceptions.DevOpsAPIErrorDescriptor.message",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "message: str | None = error_dict.get('message')",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"e... | |
astrapy.exceptions.DevOpsAPIErrorDescriptor.attributes | {
"kind": "attribute",
"name": "attributes",
"path": "astrapy.exceptions.DevOpsAPIErrorDescriptor.attributes",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "attributes: dict[str, Any] = {k: vfor (k, v) in error_dict.items() if k not in {'ID', 'message'}}",
"yields": null,
"imp... | |
astrapy.exceptions.DevOpsAPIFaultyResponseException | The DevOps API response is malformed in that it does not have
expected field(s), or they are of the wrong type. | {
"kind": "class",
"name": "DevOpsAPIFaultyResponseException",
"path": "astrapy.exceptions.DevOpsAPIFaultyResponseException",
"parameters": [
{
"name": "text",
"type": "str",
"description": null,
"default": null,
"value": null
},
{
"name": "raw_response",
"t... |
astrapy.exceptions.DevOpsAPIFaultyResponseException.text | {
"kind": "attribute",
"name": "text",
"path": "astrapy.exceptions.DevOpsAPIFaultyResponseException.text",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "text: str = text",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": n... | |
astrapy.exceptions.DevOpsAPIFaultyResponseException.raw_response | {
"kind": "attribute",
"name": "raw_response",
"path": "astrapy.exceptions.DevOpsAPIFaultyResponseException.raw_response",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "raw_response: dict[str, Any] | None = raw_response",
"yields": null,
"imports": null,
"properties": null,
... | |
astrapy.exceptions.DevOpsAPIResponseException | A request to the DevOps API returned with a non-success return code
and one of more errors in the HTTP response. | {
"kind": "class",
"name": "DevOpsAPIResponseException",
"path": "astrapy.exceptions.DevOpsAPIResponseException",
"parameters": [
{
"name": "text",
"type": "str | None",
"description": null,
"default": "None",
"value": null
},
{
"name": "command",
"type": "d... |
astrapy.exceptions.DevOpsAPIResponseException.text | {
"kind": "attribute",
"name": "text",
"path": "astrapy.exceptions.DevOpsAPIResponseException.text",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "text: str | None = text",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": ... | |
astrapy.exceptions.DevOpsAPIResponseException.command | {
"kind": "attribute",
"name": "command",
"path": "astrapy.exceptions.DevOpsAPIResponseException.command",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "command: dict[str, Any] | None = command",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"export... | |
astrapy.exceptions.DevOpsAPIResponseException.error_descriptors | {
"kind": "attribute",
"name": "error_descriptors",
"path": "astrapy.exceptions.DevOpsAPIResponseException.error_descriptors",
"parameters": null,
"returns": null,
"gathered_types": [
"DevOpsAPIErrorDescriptor"
],
"value": "error_descriptors: list[DevOpsAPIErrorDescriptor] = error_descriptors",
"y... | |
astrapy.exceptions.DevOpsAPIResponseException.from_response | Parse a raw response from the API into this exception. | {
"kind": "function",
"name": "from_response",
"path": "astrapy.exceptions.DevOpsAPIResponseException.from_response",
"parameters": [
{
"name": "command",
"type": "dict[str, Any] | None",
"description": null,
"default": null,
"value": null
},
{
"name": "raw_respon... |
astrapy.exceptions.DataAPIErrorDescriptor | An object representing a single error returned from the Data API,
typically with an error code and a text message.
An API request would return with an HTTP 200 success error code,
but contain a nonzero amount of these.
A single response from the Data API may return zero, one or more of these.
Moreover, some operations... | {
"kind": "class",
"name": "DataAPIErrorDescriptor",
"path": "astrapy.exceptions.DataAPIErrorDescriptor",
"parameters": [
{
"name": "error_dict",
"type": "dict[str, str]",
"description": null,
"default": null,
"value": null
}
],
"returns": null,
"gathered_types": null... |
astrapy.exceptions.DataAPIErrorDescriptor.title | {
"kind": "attribute",
"name": "title",
"path": "astrapy.exceptions.DataAPIErrorDescriptor.title",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "title: str | None = error_dict.get('title')",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": n... | |
astrapy.exceptions.DataAPIErrorDescriptor.error_code | {
"kind": "attribute",
"name": "error_code",
"path": "astrapy.exceptions.DataAPIErrorDescriptor.error_code",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "error_code: str | None = error_dict.get('errorCode')",
"yields": null,
"imports": null,
"properties": null,
"bases": n... | |
astrapy.exceptions.DataAPIErrorDescriptor.message | {
"kind": "attribute",
"name": "message",
"path": "astrapy.exceptions.DataAPIErrorDescriptor.message",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "message: str | None = error_dict.get('message')",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exp... | |
astrapy.exceptions.DataAPIErrorDescriptor.family | {
"kind": "attribute",
"name": "family",
"path": "astrapy.exceptions.DataAPIErrorDescriptor.family",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "family: str | None = error_dict.get('family')",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports... | |
astrapy.exceptions.DataAPIErrorDescriptor.scope | {
"kind": "attribute",
"name": "scope",
"path": "astrapy.exceptions.DataAPIErrorDescriptor.scope",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "scope: str | None = error_dict.get('scope')",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": n... | |
astrapy.exceptions.DataAPIErrorDescriptor.id | {
"kind": "attribute",
"name": "id",
"path": "astrapy.exceptions.DataAPIErrorDescriptor.id",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "id: str | None = error_dict.get('id')",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"exam... | |
astrapy.exceptions.DataAPIErrorDescriptor.attributes | {
"kind": "attribute",
"name": "attributes",
"path": "astrapy.exceptions.DataAPIErrorDescriptor.attributes",
"parameters": null,
"returns": null,
"gathered_types": [
"_known_dict_fields"
],
"value": "attributes: dict[str, Any] = {k: vfor (k, v) in error_dict.items() if k not in self._known_dict_fiel... | |
astrapy.exceptions.DataAPIDetailedErrorDescriptor | An object representing an errorful response from the Data API.
Errors specific to the Data API (as opposed to e.g. network failures)
would result in an HTTP 200 success response code but coming with
one or more DataAPIErrorDescriptor objects.
This object corresponds to one response, and as such its attributes
are a si... | {
"kind": "class",
"name": "DataAPIDetailedErrorDescriptor",
"path": "astrapy.exceptions.DataAPIDetailedErrorDescriptor",
"parameters": [
{
"name": "error_descriptors",
"type": "list[DataAPIErrorDescriptor]",
"description": null,
"default": null,
"value": null
},
{
... |
astrapy.exceptions.DataAPIDetailedErrorDescriptor.error_descriptors | {
"kind": "attribute",
"name": "error_descriptors",
"path": "astrapy.exceptions.DataAPIDetailedErrorDescriptor.error_descriptors",
"parameters": null,
"returns": null,
"gathered_types": [
"DataAPIErrorDescriptor"
],
"value": "error_descriptors: list[DataAPIErrorDescriptor]",
"yields": null,
"imp... | |
astrapy.exceptions.DataAPIDetailedErrorDescriptor.command | {
"kind": "attribute",
"name": "command",
"path": "astrapy.exceptions.DataAPIDetailedErrorDescriptor.command",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "command: dict[str, Any] | None",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": nu... | |
astrapy.exceptions.DataAPIDetailedErrorDescriptor.raw_response | {
"kind": "attribute",
"name": "raw_response",
"path": "astrapy.exceptions.DataAPIDetailedErrorDescriptor.raw_response",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "raw_response: dict[str, Any]",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"expo... | |
astrapy.exceptions.DataAPIException | Any exception occurred while issuing requests to the Data API
and specific to it, such as:
- a collection is found not to exist when gettings its metadata,
- the API return a response with an error,
but not, for instance,
- a network error while sending an HTTP request to the API. | {
"kind": "class",
"name": "DataAPIException",
"path": "astrapy.exceptions.DataAPIException",
"parameters": null,
"returns": null,
"gathered_types": [
"ValueError"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": [
"ValueError"
],
"exports": null,
"ex... |
astrapy.exceptions.DataAPIHttpException | A request to the Data API resulted in an HTTP 4xx or 5xx response.
In most cases this comes with additional information: the purpose
of this class is to present such information in a structured way,
akin to what happens for the DataAPIResponseException, while
still raising (a subclass of) `httpx.HTTPStatusError`. | {
"kind": "class",
"name": "DataAPIHttpException",
"path": "astrapy.exceptions.DataAPIHttpException",
"parameters": [
{
"name": "text",
"type": "str | None",
"description": null,
"default": null,
"value": null
},
{
"name": "httpx_error",
"type": "httpx.HTTPS... |
astrapy.exceptions.DataAPIHttpException.text | {
"kind": "attribute",
"name": "text",
"path": "astrapy.exceptions.DataAPIHttpException.text",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "text: str | None = text",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
... | |
astrapy.exceptions.DataAPIHttpException.error_descriptors | {
"kind": "attribute",
"name": "error_descriptors",
"path": "astrapy.exceptions.DataAPIHttpException.error_descriptors",
"parameters": null,
"returns": null,
"gathered_types": [
"DataAPIErrorDescriptor"
],
"value": "error_descriptors: list[DataAPIErrorDescriptor] = error_descriptors",
"yields": nu... | |
astrapy.exceptions.DataAPIHttpException.httpx_error | {
"kind": "attribute",
"name": "httpx_error",
"path": "astrapy.exceptions.DataAPIHttpException.httpx_error",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "httpx_error = httpx_error",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"... | |
astrapy.exceptions.DataAPIHttpException.from_httpx_error | Parse a httpx status error into this exception. | {
"kind": "function",
"name": "from_httpx_error",
"path": "astrapy.exceptions.DataAPIHttpException.from_httpx_error",
"parameters": [
{
"name": "cls",
"type": null,
"description": null,
"default": null,
"value": null
},
{
"name": "httpx_error",
"type": "http... |
astrapy.exceptions.DataAPITimeoutException | A Data API operation timed out. This can be a request timeout occurring
during a specific HTTP request, or can happen over the course of a method
involving several requests in a row, such as a paginated find. | {
"kind": "class",
"name": "DataAPITimeoutException",
"path": "astrapy.exceptions.DataAPITimeoutException",
"parameters": [
{
"name": "text",
"type": "str",
"description": null,
"default": null,
"value": null
},
{
"name": "timeout_type",
"type": "str",
... |
astrapy.exceptions.DataAPITimeoutException.text | {
"kind": "attribute",
"name": "text",
"path": "astrapy.exceptions.DataAPITimeoutException.text",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "text: str = text",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"r... | |
astrapy.exceptions.DataAPITimeoutException.timeout_type | {
"kind": "attribute",
"name": "timeout_type",
"path": "astrapy.exceptions.DataAPITimeoutException.timeout_type",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "timeout_type: str = timeout_type",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports... | |
astrapy.exceptions.DataAPITimeoutException.endpoint | {
"kind": "attribute",
"name": "endpoint",
"path": "astrapy.exceptions.DataAPITimeoutException.endpoint",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "endpoint: str | None = endpoint",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
... | |
astrapy.exceptions.DataAPITimeoutException.raw_payload | {
"kind": "attribute",
"name": "raw_payload",
"path": "astrapy.exceptions.DataAPITimeoutException.raw_payload",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "raw_payload: str | None = raw_payload",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"expo... | |
astrapy.exceptions.CursorIsStartedException | The cursor operation cannot be invoked if a cursor is not in its pristine
state (i.e. is already being consumed or is exhausted altogether). | {
"kind": "class",
"name": "CursorIsStartedException",
"path": "astrapy.exceptions.CursorIsStartedException",
"parameters": [
{
"name": "text",
"type": "str",
"description": null,
"default": null,
"value": null
},
{
"name": "cursor_state",
"type": "str",
... |
astrapy.exceptions.CursorIsStartedException.text | {
"kind": "attribute",
"name": "text",
"path": "astrapy.exceptions.CursorIsStartedException.text",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "text: str = text",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"... | |
astrapy.exceptions.CursorIsStartedException.cursor_state | {
"kind": "attribute",
"name": "cursor_state",
"path": "astrapy.exceptions.CursorIsStartedException.cursor_state",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "cursor_state: str = cursor_state",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"export... | |
astrapy.exceptions.CollectionNotFoundException | A collection is found non-existing and the requested operation
cannot be performed. | {
"kind": "class",
"name": "CollectionNotFoundException",
"path": "astrapy.exceptions.CollectionNotFoundException",
"parameters": [
{
"name": "text",
"type": "str",
"description": null,
"default": null,
"value": null
},
{
"name": "keyspace",
"type": "str",
... |
astrapy.exceptions.CollectionNotFoundException.text | {
"kind": "attribute",
"name": "text",
"path": "astrapy.exceptions.CollectionNotFoundException.text",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "text: str = text",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
... | |
astrapy.exceptions.CollectionNotFoundException.keyspace | {
"kind": "attribute",
"name": "keyspace",
"path": "astrapy.exceptions.CollectionNotFoundException.keyspace",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "keyspace: str = keyspace",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"... | |
astrapy.exceptions.CollectionNotFoundException.namespace | {
"kind": "attribute",
"name": "namespace",
"path": "astrapy.exceptions.CollectionNotFoundException.namespace",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "namespace: str = keyspace",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
... | |
astrapy.exceptions.CollectionNotFoundException.collection_name | {
"kind": "attribute",
"name": "collection_name",
"path": "astrapy.exceptions.CollectionNotFoundException.collection_name",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "collection_name: str = collection_name",
"yields": null,
"imports": null,
"properties": null,
"bases": ... | |
astrapy.exceptions.CollectionAlreadyExistsException | An operation expected a collection not to exist, yet it has
been detected as pre-existing. | {
"kind": "class",
"name": "CollectionAlreadyExistsException",
"path": "astrapy.exceptions.CollectionAlreadyExistsException",
"parameters": [
{
"name": "text",
"type": "str",
"description": null,
"default": null,
"value": null
},
{
"name": "keyspace",
"type"... |
astrapy.exceptions.CollectionAlreadyExistsException.text | {
"kind": "attribute",
"name": "text",
"path": "astrapy.exceptions.CollectionAlreadyExistsException.text",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "text: str = text",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": n... | |
astrapy.exceptions.CollectionAlreadyExistsException.keyspace | {
"kind": "attribute",
"name": "keyspace",
"path": "astrapy.exceptions.CollectionAlreadyExistsException.keyspace",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "keyspace: str = keyspace",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null... | |
astrapy.exceptions.CollectionAlreadyExistsException.namespace | {
"kind": "attribute",
"name": "namespace",
"path": "astrapy.exceptions.CollectionAlreadyExistsException.namespace",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "namespace: str = keyspace",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": n... | |
astrapy.exceptions.CollectionAlreadyExistsException.collection_name | {
"kind": "attribute",
"name": "collection_name",
"path": "astrapy.exceptions.CollectionAlreadyExistsException.collection_name",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "collection_name: str = collection_name",
"yields": null,
"imports": null,
"properties": null,
"bas... | |
astrapy.exceptions.TooManyDocumentsToCountException | A `count_documents()` operation failed because the resulting number of documents
exceeded either the upper bound set by the caller or the hard limit imposed
by the Data API. | {
"kind": "class",
"name": "TooManyDocumentsToCountException",
"path": "astrapy.exceptions.TooManyDocumentsToCountException",
"parameters": [
{
"name": "text",
"type": "str",
"description": null,
"default": null,
"value": null
},
{
"name": "server_max_count_exceed... |
astrapy.exceptions.TooManyDocumentsToCountException.text | {
"kind": "attribute",
"name": "text",
"path": "astrapy.exceptions.TooManyDocumentsToCountException.text",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "text: str = text",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": n... | |
astrapy.exceptions.TooManyDocumentsToCountException.server_max_count_exceeded | {
"kind": "attribute",
"name": "server_max_count_exceeded",
"path": "astrapy.exceptions.TooManyDocumentsToCountException.server_max_count_exceeded",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "server_max_count_exceeded: bool = server_max_count_exceeded",
"yields": null,
"imp... | |
astrapy.exceptions.DataAPIFaultyResponseException | The Data API response is malformed in that it does not have
expected field(s), or they are of the wrong type. | {
"kind": "class",
"name": "DataAPIFaultyResponseException",
"path": "astrapy.exceptions.DataAPIFaultyResponseException",
"parameters": [
{
"name": "text",
"type": "str",
"description": null,
"default": null,
"value": null
},
{
"name": "raw_response",
"type"... |
astrapy.exceptions.DataAPIFaultyResponseException.text | {
"kind": "attribute",
"name": "text",
"path": "astrapy.exceptions.DataAPIFaultyResponseException.text",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "text: str = text",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": nul... | |
astrapy.exceptions.DataAPIFaultyResponseException.raw_response | {
"kind": "attribute",
"name": "raw_response",
"path": "astrapy.exceptions.DataAPIFaultyResponseException.raw_response",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "raw_response: dict[str, Any] | None = raw_response",
"yields": null,
"imports": null,
"properties": null,
... | |
astrapy.exceptions.DataAPIResponseException | The Data API returned an HTTP 200 success response, which however
reports about API-specific error(s), possibly alongside partial successes.
This exception is related to an operation that can have spanned several
HTTP requests in sequence (e.g. a chunked insert_many). For this
reason, it should be not thought as being... | {
"kind": "class",
"name": "DataAPIResponseException",
"path": "astrapy.exceptions.DataAPIResponseException",
"parameters": [
{
"name": "text",
"type": "str | None",
"description": null,
"default": null,
"value": null
},
{
"name": "error_descriptors",
"type"... |
astrapy.exceptions.DataAPIResponseException.text | {
"kind": "attribute",
"name": "text",
"path": "astrapy.exceptions.DataAPIResponseException.text",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "text: str | None = text",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": nu... | |
astrapy.exceptions.DataAPIResponseException.error_descriptors | {
"kind": "attribute",
"name": "error_descriptors",
"path": "astrapy.exceptions.DataAPIResponseException.error_descriptors",
"parameters": null,
"returns": null,
"gathered_types": [
"DataAPIErrorDescriptor"
],
"value": "error_descriptors: list[DataAPIErrorDescriptor] = error_descriptors",
"yields"... | |
astrapy.exceptions.DataAPIResponseException.detailed_error_descriptors | {
"kind": "attribute",
"name": "detailed_error_descriptors",
"path": "astrapy.exceptions.DataAPIResponseException.detailed_error_descriptors",
"parameters": null,
"returns": null,
"gathered_types": [
"DataAPIDetailedErrorDescriptor"
],
"value": "detailed_error_descriptors: list[DataAPIDetailedErrorD... | |
astrapy.exceptions.DataAPIResponseException.from_response | Parse a raw response from the API into this exception. | {
"kind": "function",
"name": "from_response",
"path": "astrapy.exceptions.DataAPIResponseException.from_response",
"parameters": [
{
"name": "cls",
"type": null,
"description": null,
"default": null,
"value": null
},
{
"name": "command",
"type": "dict[str, ... |
astrapy.exceptions.DataAPIResponseException.from_responses | Parse a list of raw responses from the API into this exception. | {
"kind": "function",
"name": "from_responses",
"path": "astrapy.exceptions.DataAPIResponseException.from_responses",
"parameters": [
{
"name": "cls",
"type": null,
"description": null,
"default": null,
"value": null
},
{
"name": "commands",
"type": "list[di... |
astrapy.exceptions.DataAPIResponseException.data_api_response_exception | Cast the exception, whatever the subclass, into this parent superclass. | {
"kind": "function",
"name": "data_api_response_exception",
"path": "astrapy.exceptions.DataAPIResponseException.data_api_response_exception",
"parameters": null,
"returns": [
{
"name": null,
"type": "DataAPIResponseException",
"description": null
}
],
"gathered_types": [
"a... |
astrapy.exceptions.CumulativeOperationException | An exception of type DataAPIResponseException (see) occurred
during an operation that in general spans several requests.
As such, besides information on the error, it may have accumulated
a partial result from past successful Data API requests. | {
"kind": "class",
"name": "CumulativeOperationException",
"path": "astrapy.exceptions.CumulativeOperationException",
"parameters": [
{
"name": "text",
"type": "str | None",
"description": null,
"default": null,
"value": null
},
{
"name": "error_descriptors",
... |
astrapy.exceptions.CumulativeOperationException.partial_result | {
"kind": "attribute",
"name": "partial_result",
"path": "astrapy.exceptions.CumulativeOperationException.partial_result",
"parameters": null,
"returns": null,
"gathered_types": [
"astrapy.results.OperationResult"
],
"value": "partial_result: OperationResult",
"yields": null,
"imports": null,
... | |
astrapy.exceptions.InsertManyException | An exception of type DataAPIResponseException (see) occurred
during an insert_many (that in general spans several requests).
As such, besides information on the error, it may have accumulated
a partial result from past successful Data API requests. | {
"kind": "class",
"name": "InsertManyException",
"path": "astrapy.exceptions.InsertManyException",
"parameters": [
{
"name": "text",
"type": "str",
"description": null,
"default": null,
"value": null
},
{
"name": "partial_result",
"type": "InsertManyResult"... |
astrapy.exceptions.InsertManyException.partial_result | {
"kind": "attribute",
"name": "partial_result",
"path": "astrapy.exceptions.InsertManyException.partial_result",
"parameters": null,
"returns": null,
"gathered_types": [
"astrapy.results.InsertManyResult"
],
"value": "partial_result: InsertManyResult = partial_result",
"yields": null,
"imports"... | |
astrapy.exceptions.DeleteManyException | An exception of type DataAPIResponseException (see) occurred
during a delete_many (that in general spans several requests).
As such, besides information on the error, it may have accumulated
a partial result from past successful Data API requests. | {
"kind": "class",
"name": "DeleteManyException",
"path": "astrapy.exceptions.DeleteManyException",
"parameters": [
{
"name": "text",
"type": "str",
"description": null,
"default": null,
"value": null
},
{
"name": "partial_result",
"type": "DeleteResult",
... |
astrapy.exceptions.DeleteManyException.partial_result | {
"kind": "attribute",
"name": "partial_result",
"path": "astrapy.exceptions.DeleteManyException.partial_result",
"parameters": null,
"returns": null,
"gathered_types": [
"astrapy.results.DeleteResult"
],
"value": "partial_result: DeleteResult = partial_result",
"yields": null,
"imports": null,
... | |
astrapy.exceptions.UpdateManyException | An exception of type DataAPIResponseException (see) occurred
during an update_many (that in general spans several requests).
As such, besides information on the error, it may have accumulated
a partial result from past successful Data API requests. | {
"kind": "class",
"name": "UpdateManyException",
"path": "astrapy.exceptions.UpdateManyException",
"parameters": [
{
"name": "text",
"type": "str",
"description": null,
"default": null,
"value": null
},
{
"name": "partial_result",
"type": "UpdateResult",
... |
astrapy.exceptions.UpdateManyException.partial_result | {
"kind": "attribute",
"name": "partial_result",
"path": "astrapy.exceptions.UpdateManyException.partial_result",
"parameters": null,
"returns": null,
"gathered_types": [
"astrapy.results.UpdateResult"
],
"value": "partial_result: UpdateResult = partial_result",
"yields": null,
"imports": null,
... | |
astrapy.exceptions.BulkWriteException | An exception of type DataAPIResponseException (see) occurred
during a bulk_write of a list of operations.
As such, besides information on the error, it may have accumulated
a partial result from past successful operations. | {
"kind": "class",
"name": "BulkWriteException",
"path": "astrapy.exceptions.BulkWriteException",
"parameters": [
{
"name": "text",
"type": "str | None",
"description": null,
"default": null,
"value": null
},
{
"name": "partial_result",
"type": "BulkWriteRes... |
astrapy.exceptions.BulkWriteException.partial_result | {
"kind": "attribute",
"name": "partial_result",
"path": "astrapy.exceptions.BulkWriteException.partial_result",
"parameters": null,
"returns": null,
"gathered_types": [
"astrapy.results.BulkWriteResult"
],
"value": "partial_result: BulkWriteResult = partial_result",
"yields": null,
"imports": n... | |
astrapy.exceptions.BulkWriteException.exceptions | {
"kind": "attribute",
"name": "exceptions",
"path": "astrapy.exceptions.BulkWriteException.exceptions",
"parameters": null,
"returns": null,
"gathered_types": [
"astrapy.exceptions.DataAPIResponseException"
],
"value": "exceptions: list[DataAPIResponseException] = exceptions",
"yields": null,
"... | |
astrapy.exceptions.to_dataapi_timeout_exception | {
"kind": "function",
"name": "to_dataapi_timeout_exception",
"path": "astrapy.exceptions.to_dataapi_timeout_exception",
"parameters": [
{
"name": "httpx_timeout",
"type": "httpx.TimeoutException",
"description": null,
"default": null,
"value": null
}
],
"returns": [
... | |
astrapy.exceptions.to_devopsapi_timeout_exception | {
"kind": "function",
"name": "to_devopsapi_timeout_exception",
"path": "astrapy.exceptions.to_devopsapi_timeout_exception",
"parameters": [
{
"name": "httpx_timeout",
"type": "httpx.TimeoutException",
"description": null,
"default": null,
"value": null
}
],
"returns": ... | |
astrapy.exceptions.base_timeout_info | {
"kind": "function",
"name": "base_timeout_info",
"path": "astrapy.exceptions.base_timeout_info",
"parameters": [
{
"name": "max_time_ms",
"type": "int | None",
"description": null,
"default": null,
"value": null
}
],
"returns": [
{
"name": null,
"type"... | |
astrapy.exceptions.MultiCallTimeoutManager | A helper class to keep track of timing and timeouts
in a multi-call method context. | {
"kind": "class",
"name": "MultiCallTimeoutManager",
"path": "astrapy.exceptions.MultiCallTimeoutManager",
"parameters": [
{
"name": "overall_max_time_ms",
"type": "int | None",
"description": "an optional max duration to track (milliseconds)",
"default": null,
"value": null
... |
astrapy.exceptions.MultiCallTimeoutManager.overall_max_time_ms | {
"kind": "attribute",
"name": "overall_max_time_ms",
"path": "astrapy.exceptions.MultiCallTimeoutManager.overall_max_time_ms",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "overall_max_time_ms: int | None = overall_max_time_ms",
"yields": null,
"imports": null,
"properties"... | |
astrapy.exceptions.MultiCallTimeoutManager.started_ms | {
"kind": "attribute",
"name": "started_ms",
"path": "astrapy.exceptions.MultiCallTimeoutManager.started_ms",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "started_ms: int = int(time.time() * 1000)",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"ex... | |
astrapy.exceptions.MultiCallTimeoutManager.deadline_ms | {
"kind": "attribute",
"name": "deadline_ms",
"path": "astrapy.exceptions.MultiCallTimeoutManager.deadline_ms",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "deadline_ms: int | None",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
... | |
astrapy.exceptions.MultiCallTimeoutManager.dev_ops_api | {
"kind": "attribute",
"name": "dev_ops_api",
"path": "astrapy.exceptions.MultiCallTimeoutManager.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,
... |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.