id stringlengths 7 77 | text stringlengths 0 3.4k | metadata dict |
|---|---|---|
astrapy.meta.check_update_db_namespace_keyspace | {
"kind": "function",
"name": "check_update_db_namespace_keyspace",
"path": "astrapy.meta.check_update_db_namespace_keyspace",
"parameters": [
{
"name": "update_db_keyspace",
"type": "bool | None",
"description": null,
"default": null,
"value": null
},
{
"name": "... | |
astrapy.core | {
"kind": "module",
"name": "core",
"path": "astrapy.core",
"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.core.DEPRECATED_MODULE_PATHS | {
"kind": "attribute",
"name": "DEPRECATED_MODULE_PATHS",
"path": "astrapy.core.DEPRECATED_MODULE_PATHS",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "DEPRECATED_MODULE_PATHS = {'astrapy.api', 'astrapy.core', 'astrapy.db', 'astrapy.ops'}",
"yields": null,
"imports": null,
"... | |
astrapy.core.issue_deprecation_warning | Issue a DeprecatedWarning (subclass of DeprecationWarning).
In order to correctly refer to user code, this function needs to
dynamically adjust the `stacklevel` parameter. | {
"kind": "function",
"name": "issue_deprecation_warning",
"path": "astrapy.core.issue_deprecation_warning",
"parameters": null,
"returns": [
{
"name": null,
"type": "None",
"description": null
}
],
"gathered_types": null,
"value": null,
"yields": null,
"imports": null,
"... |
astrapy.core.db | {
"kind": "module",
"name": "db",
"path": "astrapy.core.db",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": null,
"yields": null,
"imports": {
"annotations": "__future__.annotations",
"logging": "logging",
"Any": "typing.Any",
"cast": "typing.cast",
"httpx": ... | |
astrapy.core.db.logger | {
"kind": "attribute",
"name": "logger",
"path": "astrapy.core.db.logger",
"parameters": null,
"returns": null,
"gathered_types": [
"__name__"
],
"value": "logger = logging.getLogger(__name__)",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example... | |
astrapy.core.db._PrefetchIterator.queue | {
"kind": "attribute",
"name": "queue",
"path": "astrapy.core.db._PrefetchIterator.queue",
"parameters": null,
"returns": null,
"gathered_types": [
"Queue",
"astrapy.core.core_types.API_DOC"
],
"value": "queue: queue.Queue[API_DOC | None] = queue.Queue(prefetched)",
"yields": null,
"imports"... | |
astrapy.core.db._PrefetchIterator.request_method | {
"kind": "attribute",
"name": "request_method",
"path": "astrapy.core.db._PrefetchIterator.request_method",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "request_method = request_method",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": nul... | |
astrapy.core.db._PrefetchIterator.options | {
"kind": "attribute",
"name": "options",
"path": "astrapy.core.db._PrefetchIterator.options",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "options = options",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"ref... | |
astrapy.core.db._PrefetchIterator.raw_response_callback | {
"kind": "attribute",
"name": "raw_response_callback",
"path": "astrapy.core.db._PrefetchIterator.raw_response_callback",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "raw_response_callback = raw_response_callback",
"yields": null,
"imports": null,
"properties": null,
"ba... | |
astrapy.core.db._PrefetchIterator.initialised | {
"kind": "attribute",
"name": "initialised",
"path": "astrapy.core.db._PrefetchIterator.initialised",
"parameters": null,
"returns": null,
"gathered_types": [
"Event"
],
"value": "initialised = threading.Event()",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"export... | |
astrapy.core.db._PrefetchIterator.stop | {
"kind": "attribute",
"name": "stop",
"path": "astrapy.core.db._PrefetchIterator.stop",
"parameters": null,
"returns": null,
"gathered_types": [
"Event"
],
"value": "stop = threading.Event()",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example"... | |
astrapy.core.db._PrefetchIterator.thread | {
"kind": "attribute",
"name": "thread",
"path": "astrapy.core.db._PrefetchIterator.thread",
"parameters": null,
"returns": null,
"gathered_types": [
"Thread",
"_PrefetchIterator"
],
"value": "thread = threading.Thread(target=_PrefetchIterator.queued_paginate, args=(weakref.proxy(self),))",
"y... | |
astrapy.core.db._PrefetchIterator.queue_put | {
"kind": "function",
"name": "queue_put",
"path": "astrapy.core.db._PrefetchIterator.queue_put",
"parameters": [
{
"name": "q",
"type": "queue.Queue[API_DOC | None]",
"description": null,
"default": null,
"value": null
},
{
"name": "item",
"type": "API_DOC ... | |
astrapy.core.db._PrefetchIterator.queued_paginate | {
"kind": "function",
"name": "queued_paginate",
"path": "astrapy.core.db._PrefetchIterator.queued_paginate",
"parameters": null,
"returns": [
{
"name": null,
"type": "None",
"description": null
}
],
"gathered_types": null,
"value": null,
"yields": null,
"imports": null,
... | |
astrapy.core.db.AstraDBCollection | {
"kind": "class",
"name": "AstraDBCollection",
"path": "astrapy.core.db.AstraDBCollection",
"parameters": [
{
"name": "collection_name",
"type": "str",
"description": null,
"default": null,
"value": null
},
{
"name": "astra_db",
"type": "AstraDB | None",
... | |
astrapy.core.db.AstraDBCollection.client | {
"kind": "attribute",
"name": "client",
"path": "astrapy.core.db.AstraDBCollection.client",
"parameters": null,
"returns": null,
"gathered_types": [
"Client"
],
"value": "client = httpx.Client()",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"exam... | |
astrapy.core.db.AstraDBCollection.astra_db | {
"kind": "attribute",
"name": "astra_db",
"path": "astrapy.core.db.AstraDBCollection.astra_db",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "astra_db = astra_db",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
... | |
astrapy.core.db.AstraDBCollection.caller_name | {
"kind": "attribute",
"name": "caller_name",
"path": "astrapy.core.db.AstraDBCollection.caller_name",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "caller_name: str | None = self.astra_db.caller_name",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
... | |
astrapy.core.db.AstraDBCollection.caller_version | {
"kind": "attribute",
"name": "caller_version",
"path": "astrapy.core.db.AstraDBCollection.caller_version",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "caller_version: str | None = self.astra_db.caller_version",
"yields": null,
"imports": null,
"properties": null,
"base... | |
astrapy.core.db.AstraDBCollection.additional_headers | {
"kind": "attribute",
"name": "additional_headers",
"path": "astrapy.core.db.AstraDBCollection.additional_headers",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "additional_headers = additional_headers",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
... | |
astrapy.core.db.AstraDBCollection.collection_name | {
"kind": "attribute",
"name": "collection_name",
"path": "astrapy.core.db.AstraDBCollection.collection_name",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "collection_name = collection_name",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports":... | |
astrapy.core.db.AstraDBCollection.base_path | {
"kind": "attribute",
"name": "base_path",
"path": "astrapy.core.db.AstraDBCollection.base_path",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "base_path: str = f'{self.astra_db.base_path}/{self.collection_name}'",
"yields": null,
"imports": null,
"properties": null,
"bas... | |
astrapy.core.db.AstraDBCollection.copy | {
"kind": "function",
"name": "copy",
"path": "astrapy.core.db.AstraDBCollection.copy",
"parameters": [
{
"name": "collection_name",
"type": "str | None",
"description": null,
"default": "None",
"value": null
},
{
"name": "token",
"type": "str | None",
... | |
astrapy.core.db.AstraDBCollection.to_async | {
"kind": "function",
"name": "to_async",
"path": "astrapy.core.db.AstraDBCollection.to_async",
"parameters": null,
"returns": [
{
"name": null,
"type": "AsyncAstraDBCollection",
"description": null
}
],
"gathered_types": [
"astrapy.core.db.AsyncAstraDBCollection"
],
"val... | |
astrapy.core.db.AstraDBCollection.set_caller | {
"kind": "function",
"name": "set_caller",
"path": "astrapy.core.db.AstraDBCollection.set_caller",
"parameters": [
{
"name": "caller_name",
"type": "str | None",
"description": null,
"default": "None",
"value": null
},
{
"name": "caller_version",
"type": "s... | |
astrapy.core.db.AstraDBCollection.post_raw_request | {
"kind": "function",
"name": "post_raw_request",
"path": "astrapy.core.db.AstraDBCollection.post_raw_request",
"parameters": [
{
"name": "body",
"type": "dict[str, Any]",
"description": null,
"default": null,
"value": null
},
{
"name": "timeout_info",
"type... | |
astrapy.core.db.AstraDBCollection.get | Retrieve a document from the collection by its path. | {
"kind": "function",
"name": "get",
"path": "astrapy.core.db.AstraDBCollection.get",
"parameters": [
{
"name": "path",
"type": "str",
"description": "The path of the document to retrieve.",
"default": "None",
"value": "None"
},
{
"name": "timeout_info",
"ty... |
astrapy.core.db.AstraDBCollection.find | Find documents in the collection that match the given filter. | {
"kind": "function",
"name": "find",
"path": "astrapy.core.db.AstraDBCollection.find",
"parameters": [
{
"name": "filter",
"type": "dict",
"description": "Criteria to filter documents.",
"default": "None",
"value": "None"
},
{
"name": "projection",
"type": ... |
astrapy.core.db.AstraDBCollection.vector_find | Perform a vector-based search in the collection. | {
"kind": "function",
"name": "vector_find",
"path": "astrapy.core.db.AstraDBCollection.vector_find",
"parameters": [
{
"name": "vector",
"type": "list",
"description": "The vector to search with.",
"default": null,
"value": null
},
{
"name": "limit",
"type"... |
astrapy.core.db.AstraDBCollection.paginate | Generate paginated results for a given database query method. | {
"kind": "function",
"name": "paginate",
"path": "astrapy.core.db.AstraDBCollection.paginate",
"parameters": [
{
"name": "request_method",
"type": "function",
"description": "The database query method to paginate.",
"default": null,
"value": null
},
{
"name": "op... |
astrapy.core.db.AstraDBCollection.paginated_find | Perform a paginated search in the collection. | {
"kind": "function",
"name": "paginated_find",
"path": "astrapy.core.db.AstraDBCollection.paginated_find",
"parameters": [
{
"name": "filter",
"type": "dict",
"description": "Criteria to filter documents.",
"default": "None",
"value": "None"
},
{
"name": "project... |
astrapy.core.db.AstraDBCollection.pop | Pop the last data in the tags array | {
"kind": "function",
"name": "pop",
"path": "astrapy.core.db.AstraDBCollection.pop",
"parameters": [
{
"name": "filter",
"type": "dict",
"description": "Criteria to identify the document to update.",
"default": null,
"value": null
},
{
"name": "pop",
"type"... |
astrapy.core.db.AstraDBCollection.push | Push new data to the tags array | {
"kind": "function",
"name": "push",
"path": "astrapy.core.db.AstraDBCollection.push",
"parameters": [
{
"name": "filter",
"type": "dict",
"description": "Criteria to identify the document to update.",
"default": null,
"value": null
},
{
"name": "push",
"ty... |
astrapy.core.db.AstraDBCollection.find_one_and_replace | Find a single document and replace it. | {
"kind": "function",
"name": "find_one_and_replace",
"path": "astrapy.core.db.AstraDBCollection.find_one_and_replace",
"parameters": [
{
"name": "replacement",
"type": "dict",
"description": "The new document to replace the existing one.",
"default": null,
"value": null
},... |
astrapy.core.db.AstraDBCollection.vector_find_one_and_replace | Perform a vector-based search and replace the first matched document. | {
"kind": "function",
"name": "vector_find_one_and_replace",
"path": "astrapy.core.db.AstraDBCollection.vector_find_one_and_replace",
"parameters": [
{
"name": "vector",
"type": "dict",
"description": "The vector to search with.",
"default": null,
"value": null
},
{
... |
astrapy.core.db.AstraDBCollection.find_one_and_update | Find a single document and update it. | {
"kind": "function",
"name": "find_one_and_update",
"path": "astrapy.core.db.AstraDBCollection.find_one_and_update",
"parameters": [
{
"name": "update",
"type": "dict",
"description": "The update to apply to the document.",
"default": null,
"value": null
},
{
"na... |
astrapy.core.db.AstraDBCollection.vector_find_one_and_update | Perform a vector-based search and update the first matched document. | {
"kind": "function",
"name": "vector_find_one_and_update",
"path": "astrapy.core.db.AstraDBCollection.vector_find_one_and_update",
"parameters": [
{
"name": "vector",
"type": "list",
"description": "The vector to search with.",
"default": null,
"value": null
},
{
... |
astrapy.core.db.AstraDBCollection.find_one_and_delete | Find a single document and delete it. | {
"kind": "function",
"name": "find_one_and_delete",
"path": "astrapy.core.db.AstraDBCollection.find_one_and_delete",
"parameters": [
{
"name": "sort",
"type": "dict",
"description": "Specifies the order in which to find the document.",
"default": "{}",
"value": "{}"
},
... |
astrapy.core.db.AstraDBCollection.count_documents | Count documents matching a given predicate (expressed as filter). | {
"kind": "function",
"name": "count_documents",
"path": "astrapy.core.db.AstraDBCollection.count_documents",
"parameters": [
{
"name": "filter",
"type": "dict, defaults to {}",
"description": "Criteria to filter documents.",
"default": "{}",
"value": "{}"
},
{
"n... |
astrapy.core.db.AstraDBCollection.find_one | Find a single document in the collection. | {
"kind": "function",
"name": "find_one",
"path": "astrapy.core.db.AstraDBCollection.find_one",
"parameters": [
{
"name": "filter",
"type": "dict",
"description": "Criteria to filter documents.",
"default": "{}",
"value": "{}"
},
{
"name": "projection",
"typ... |
astrapy.core.db.AstraDBCollection.vector_find_one | Perform a vector-based search to find a single document in the collection. | {
"kind": "function",
"name": "vector_find_one",
"path": "astrapy.core.db.AstraDBCollection.vector_find_one",
"parameters": [
{
"name": "vector",
"type": "list",
"description": "The vector to search with.",
"default": null,
"value": null
},
{
"name": "filter",
... |
astrapy.core.db.AstraDBCollection.insert_one | Insert a single document into the collection. | {
"kind": "function",
"name": "insert_one",
"path": "astrapy.core.db.AstraDBCollection.insert_one",
"parameters": [
{
"name": "document",
"type": "dict",
"description": "The document to insert.",
"default": null,
"value": null
},
{
"name": "failures_allowed",
... |
astrapy.core.db.AstraDBCollection.insert_many | Insert multiple documents into the collection. | {
"kind": "function",
"name": "insert_many",
"path": "astrapy.core.db.AstraDBCollection.insert_many",
"parameters": [
{
"name": "documents",
"type": "list",
"description": "A list of documents to insert.",
"default": null,
"value": null
},
{
"name": "options",
... |
astrapy.core.db.AstraDBCollection.chunked_insert_many | Insert multiple documents into the collection, handling chunking and
optionally with concurrent insertions. | {
"kind": "function",
"name": "chunked_insert_many",
"path": "astrapy.core.db.AstraDBCollection.chunked_insert_many",
"parameters": [
{
"name": "documents",
"type": "list",
"description": "A list of documents to insert.",
"default": null,
"value": null
},
{
"name"... |
astrapy.core.db.AstraDBCollection.update_one | Update a single document in the collection. | {
"kind": "function",
"name": "update_one",
"path": "astrapy.core.db.AstraDBCollection.update_one",
"parameters": [
{
"name": "filter",
"type": "dict",
"description": "Criteria to identify the document to update.",
"default": null,
"value": null
},
{
"name": "upda... |
astrapy.core.db.AstraDBCollection.update_many | Updates multiple documents in the collection. | {
"kind": "function",
"name": "update_many",
"path": "astrapy.core.db.AstraDBCollection.update_many",
"parameters": [
{
"name": "filter",
"type": "dict",
"description": "Criteria to identify the document to update.",
"default": null,
"value": null
},
{
"name": "up... |
astrapy.core.db.AstraDBCollection.replace | Replace a document in the collection. | {
"kind": "function",
"name": "replace",
"path": "astrapy.core.db.AstraDBCollection.replace",
"parameters": [
{
"name": "path",
"type": "str",
"description": "The path to the document to replace.",
"default": null,
"value": null
},
{
"name": "document",
"typ... |
astrapy.core.db.AstraDBCollection.delete_one | Delete a single document from the collection based on its ID. | {
"kind": "function",
"name": "delete_one",
"path": "astrapy.core.db.AstraDBCollection.delete_one",
"parameters": [
{
"name": "id",
"type": "str",
"description": "The ID of the document to delete.",
"default": null,
"value": null
},
{
"name": "timeout_info",
... |
astrapy.core.db.AstraDBCollection.delete_one_by_predicate | Delete a single document from the collection based on a filter clause | {
"kind": "function",
"name": "delete_one_by_predicate",
"path": "astrapy.core.db.AstraDBCollection.delete_one_by_predicate",
"parameters": [
{
"name": "filter",
"type": "dict[str, Any]",
"description": "any filter dictionary",
"default": null,
"value": null
},
{
... |
astrapy.core.db.AstraDBCollection.delete_many | Delete many documents from the collection based on a filter condition | {
"kind": "function",
"name": "delete_many",
"path": "astrapy.core.db.AstraDBCollection.delete_many",
"parameters": [
{
"name": "filter",
"type": "dict",
"description": "Criteria to identify the documents to delete.",
"default": null,
"value": null
},
{
"name": "s... |
astrapy.core.db.AstraDBCollection.chunked_delete_many | Delete many documents from the collection based on a filter condition,
chaining several API calls until exhaustion of the documents to delete. | {
"kind": "function",
"name": "chunked_delete_many",
"path": "astrapy.core.db.AstraDBCollection.chunked_delete_many",
"parameters": [
{
"name": "filter",
"type": "dict",
"description": "Criteria to identify the documents to delete.",
"default": null,
"value": null
},
{
... |
astrapy.core.db.AstraDBCollection.clear | Clear the collection, deleting all documents | {
"kind": "function",
"name": "clear",
"path": "astrapy.core.db.AstraDBCollection.clear",
"parameters": [
{
"name": "timeout_info",
"type": "TimeoutInfoWideType",
"description": "a float, or a TimeoutInfo dict, for the HTTP request.\nNote that a 'read' timeout event will not block the acti... |
astrapy.core.db.AstraDBCollection.delete_subdocument | Delete a subdocument or field from a document in the collection. | {
"kind": "function",
"name": "delete_subdocument",
"path": "astrapy.core.db.AstraDBCollection.delete_subdocument",
"parameters": [
{
"name": "id",
"type": "str",
"description": "The ID of the document containing the subdocument.",
"default": null,
"value": null
},
{
... |
astrapy.core.db.AstraDBCollection.upsert_one | Emulate an upsert operation for a single document in the collection.
This method attempts to insert the document.
If a document with the same _id exists, it updates the existing document. | {
"kind": "function",
"name": "upsert_one",
"path": "astrapy.core.db.AstraDBCollection.upsert_one",
"parameters": [
{
"name": "document",
"type": "dict",
"description": "The document to insert or update.",
"default": null,
"value": null
},
{
"name": "timeout_info"... |
astrapy.core.db.AstraDBCollection.upsert_many | Emulate an upsert operation for multiple documents in the collection.
This method attempts to insert the documents.
If a document with the same _id exists, it updates the existing document. | {
"kind": "function",
"name": "upsert_many",
"path": "astrapy.core.db.AstraDBCollection.upsert_many",
"parameters": [
{
"name": "documents",
"type": "List[dict]",
"description": "The documents to insert or update.",
"default": null,
"value": null
},
{
"name": "con... |
astrapy.core.db.AsyncAstraDBCollection | {
"kind": "class",
"name": "AsyncAstraDBCollection",
"path": "astrapy.core.db.AsyncAstraDBCollection",
"parameters": [
{
"name": "collection_name",
"type": "str",
"description": null,
"default": null,
"value": null
},
{
"name": "astra_db",
"type": "AsyncAstr... | |
astrapy.core.db.AsyncAstraDBCollection.astra_db | {
"kind": "attribute",
"name": "astra_db",
"path": "astrapy.core.db.AsyncAstraDBCollection.astra_db",
"parameters": null,
"returns": null,
"gathered_types": [
"astrapy.core.db.AsyncAstraDB"
],
"value": "astra_db: AsyncAstraDB = astra_db",
"yields": null,
"imports": null,
"properties": null,
... | |
astrapy.core.db.AsyncAstraDBCollection.caller_name | {
"kind": "attribute",
"name": "caller_name",
"path": "astrapy.core.db.AsyncAstraDBCollection.caller_name",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "caller_name: str | None = self.astra_db.caller_name",
"yields": null,
"imports": null,
"properties": null,
"bases": nul... | |
astrapy.core.db.AsyncAstraDBCollection.caller_version | {
"kind": "attribute",
"name": "caller_version",
"path": "astrapy.core.db.AsyncAstraDBCollection.caller_version",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "caller_version: str | None = self.astra_db.caller_version",
"yields": null,
"imports": null,
"properties": null,
... | |
astrapy.core.db.AsyncAstraDBCollection.additional_headers | {
"kind": "attribute",
"name": "additional_headers",
"path": "astrapy.core.db.AsyncAstraDBCollection.additional_headers",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "additional_headers = additional_headers",
"yields": null,
"imports": null,
"properties": null,
"bases": n... | |
astrapy.core.db.AsyncAstraDBCollection.client | {
"kind": "attribute",
"name": "client",
"path": "astrapy.core.db.AsyncAstraDBCollection.client",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "client = astra_db.client",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": nu... | |
astrapy.core.db.AsyncAstraDBCollection.collection_name | {
"kind": "attribute",
"name": "collection_name",
"path": "astrapy.core.db.AsyncAstraDBCollection.collection_name",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "collection_name = collection_name",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"expo... | |
astrapy.core.db.AsyncAstraDBCollection.base_path | {
"kind": "attribute",
"name": "base_path",
"path": "astrapy.core.db.AsyncAstraDBCollection.base_path",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "base_path: str = f'{self.astra_db.base_path}/{self.collection_name}'",
"yields": null,
"imports": null,
"properties": null,
... | |
astrapy.core.db.AsyncAstraDBCollection.copy | {
"kind": "function",
"name": "copy",
"path": "astrapy.core.db.AsyncAstraDBCollection.copy",
"parameters": [
{
"name": "collection_name",
"type": "str | None",
"description": null,
"default": "None",
"value": null
},
{
"name": "token",
"type": "str | None",
... | |
astrapy.core.db.AsyncAstraDBCollection.set_caller | {
"kind": "function",
"name": "set_caller",
"path": "astrapy.core.db.AsyncAstraDBCollection.set_caller",
"parameters": [
{
"name": "caller_name",
"type": "str | None",
"description": null,
"default": "None",
"value": null
},
{
"name": "caller_version",
"type... | |
astrapy.core.db.AsyncAstraDBCollection.to_sync | {
"kind": "function",
"name": "to_sync",
"path": "astrapy.core.db.AsyncAstraDBCollection.to_sync",
"parameters": null,
"returns": [
{
"name": null,
"type": "AstraDBCollection",
"description": null
}
],
"gathered_types": [
"astrapy.core.db.AstraDBCollection"
],
"value": nu... | |
astrapy.core.db.AsyncAstraDBCollection.post_raw_request | {
"kind": "function",
"name": "post_raw_request",
"path": "astrapy.core.db.AsyncAstraDBCollection.post_raw_request",
"parameters": [
{
"name": "body",
"type": "dict[str, Any]",
"description": null,
"default": null,
"value": null
},
{
"name": "timeout_info",
... | |
astrapy.core.db.AsyncAstraDBCollection.get | Retrieve a document from the collection by its path. | {
"kind": "function",
"name": "get",
"path": "astrapy.core.db.AsyncAstraDBCollection.get",
"parameters": [
{
"name": "path",
"type": "str",
"description": "The path of the document to retrieve.",
"default": "None",
"value": "None"
},
{
"name": "timeout_info",
... |
astrapy.core.db.AsyncAstraDBCollection.find | Find documents in the collection that match the given filter. | {
"kind": "function",
"name": "find",
"path": "astrapy.core.db.AsyncAstraDBCollection.find",
"parameters": [
{
"name": "filter",
"type": "dict",
"description": "Criteria to filter documents.",
"default": "None",
"value": "None"
},
{
"name": "projection",
"ty... |
astrapy.core.db.AsyncAstraDBCollection.vector_find | Perform a vector-based search in the collection. | {
"kind": "function",
"name": "vector_find",
"path": "astrapy.core.db.AsyncAstraDBCollection.vector_find",
"parameters": [
{
"name": "vector",
"type": "list",
"description": "The vector to search with.",
"default": null,
"value": null
},
{
"name": "limit",
"... |
astrapy.core.db.AsyncAstraDBCollection.paginate | Generate paginated results for a given database query method. | {
"kind": "function",
"name": "paginate",
"path": "astrapy.core.db.AsyncAstraDBCollection.paginate",
"parameters": [
{
"name": "request_method",
"type": "function",
"description": "The database query method to paginate.",
"default": null,
"value": null
},
{
"name"... |
astrapy.core.db.AsyncAstraDBCollection.paginated_find | Perform a paginated search in the collection. | {
"kind": "function",
"name": "paginated_find",
"path": "astrapy.core.db.AsyncAstraDBCollection.paginated_find",
"parameters": [
{
"name": "filter",
"type": "dict",
"description": "Criteria to filter documents.",
"default": "None",
"value": "None"
},
{
"name": "pr... |
astrapy.core.db.AsyncAstraDBCollection.pop | Pop the last data in the tags array | {
"kind": "function",
"name": "pop",
"path": "astrapy.core.db.AsyncAstraDBCollection.pop",
"parameters": [
{
"name": "filter",
"type": "dict",
"description": "Criteria to identify the document to update.",
"default": null,
"value": null
},
{
"name": "pop",
"... |
astrapy.core.db.AsyncAstraDBCollection.push | Push new data to the tags array | {
"kind": "function",
"name": "push",
"path": "astrapy.core.db.AsyncAstraDBCollection.push",
"parameters": [
{
"name": "filter",
"type": "dict",
"description": "Criteria to identify the document to update.",
"default": null,
"value": null
},
{
"name": "push",
... |
astrapy.core.db.AsyncAstraDBCollection.find_one_and_replace | Find a single document and replace it. | {
"kind": "function",
"name": "find_one_and_replace",
"path": "astrapy.core.db.AsyncAstraDBCollection.find_one_and_replace",
"parameters": [
{
"name": "replacement",
"type": "dict",
"description": "The new document to replace the existing one.",
"default": null,
"value": null
... |
astrapy.core.db.AsyncAstraDBCollection.vector_find_one_and_replace | Perform a vector-based search and replace the first matched document. | {
"kind": "function",
"name": "vector_find_one_and_replace",
"path": "astrapy.core.db.AsyncAstraDBCollection.vector_find_one_and_replace",
"parameters": [
{
"name": "vector",
"type": "dict",
"description": "The vector to search with.",
"default": null,
"value": null
},
... |
astrapy.core.db.AsyncAstraDBCollection.find_one_and_update | Find a single document and update it. | {
"kind": "function",
"name": "find_one_and_update",
"path": "astrapy.core.db.AsyncAstraDBCollection.find_one_and_update",
"parameters": [
{
"name": "sort",
"type": "dict",
"description": "Specifies the order in which to find the document.",
"default": "{}",
"value": "{}"
}... |
astrapy.core.db.AsyncAstraDBCollection.vector_find_one_and_update | Perform a vector-based search and update the first matched document. | {
"kind": "function",
"name": "vector_find_one_and_update",
"path": "astrapy.core.db.AsyncAstraDBCollection.vector_find_one_and_update",
"parameters": [
{
"name": "vector",
"type": "list",
"description": "The vector to search with.",
"default": null,
"value": null
},
{
... |
astrapy.core.db.AsyncAstraDBCollection.find_one_and_delete | Find a single document and delete it. | {
"kind": "function",
"name": "find_one_and_delete",
"path": "astrapy.core.db.AsyncAstraDBCollection.find_one_and_delete",
"parameters": [
{
"name": "sort",
"type": "dict",
"description": "Specifies the order in which to find the document.",
"default": "{}",
"value": "{}"
}... |
astrapy.core.db.AsyncAstraDBCollection.count_documents | Count documents matching a given predicate (expressed as filter). | {
"kind": "function",
"name": "count_documents",
"path": "astrapy.core.db.AsyncAstraDBCollection.count_documents",
"parameters": [
{
"name": "filter",
"type": "dict, defaults to {}",
"description": "Criteria to filter documents.",
"default": "{}",
"value": "{}"
},
{
... |
astrapy.core.db.AsyncAstraDBCollection.find_one | Find a single document in the collection. | {
"kind": "function",
"name": "find_one",
"path": "astrapy.core.db.AsyncAstraDBCollection.find_one",
"parameters": [
{
"name": "filter",
"type": "dict",
"description": "Criteria to filter documents.",
"default": "{}",
"value": "{}"
},
{
"name": "projection",
... |
astrapy.core.db.AsyncAstraDBCollection.vector_find_one | Perform a vector-based search to find a single document in the collection. | {
"kind": "function",
"name": "vector_find_one",
"path": "astrapy.core.db.AsyncAstraDBCollection.vector_find_one",
"parameters": [
{
"name": "vector",
"type": "list",
"description": "The vector to search with.",
"default": null,
"value": null
},
{
"name": "filter"... |
astrapy.core.db.AsyncAstraDBCollection.insert_one | Insert a single document into the collection. | {
"kind": "function",
"name": "insert_one",
"path": "astrapy.core.db.AsyncAstraDBCollection.insert_one",
"parameters": [
{
"name": "document",
"type": "dict",
"description": "The document to insert.",
"default": null,
"value": null
},
{
"name": "failures_allowed",... |
astrapy.core.db.AsyncAstraDBCollection.insert_many | Insert multiple documents into the collection. | {
"kind": "function",
"name": "insert_many",
"path": "astrapy.core.db.AsyncAstraDBCollection.insert_many",
"parameters": [
{
"name": "documents",
"type": "list",
"description": "A list of documents to insert.",
"default": null,
"value": null
},
{
"name": "options"... |
astrapy.core.db.AsyncAstraDBCollection.chunked_insert_many | Insert multiple documents into the collection, handling chunking and
optionally with concurrent insertions. | {
"kind": "function",
"name": "chunked_insert_many",
"path": "astrapy.core.db.AsyncAstraDBCollection.chunked_insert_many",
"parameters": [
{
"name": "documents",
"type": "list",
"description": "A list of documents to insert.",
"default": null,
"value": null
},
{
"... |
astrapy.core.db.AsyncAstraDBCollection.update_one | Update a single document in the collection. | {
"kind": "function",
"name": "update_one",
"path": "astrapy.core.db.AsyncAstraDBCollection.update_one",
"parameters": [
{
"name": "filter",
"type": "dict",
"description": "Criteria to identify the document to update.",
"default": null,
"value": null
},
{
"name": ... |
astrapy.core.db.AsyncAstraDBCollection.update_many | Updates multiple documents in the collection. | {
"kind": "function",
"name": "update_many",
"path": "astrapy.core.db.AsyncAstraDBCollection.update_many",
"parameters": [
{
"name": "filter",
"type": "dict",
"description": "Criteria to identify the document to update.",
"default": null,
"value": null
},
{
"name"... |
astrapy.core.db.AsyncAstraDBCollection.replace | Replace a document in the collection. | {
"kind": "function",
"name": "replace",
"path": "astrapy.core.db.AsyncAstraDBCollection.replace",
"parameters": [
{
"name": "path",
"type": "str",
"description": "The path to the document to replace.",
"default": null,
"value": null
},
{
"name": "document",
... |
astrapy.core.db.AsyncAstraDBCollection.delete_one | Delete a single document from the collection based on its ID. | {
"kind": "function",
"name": "delete_one",
"path": "astrapy.core.db.AsyncAstraDBCollection.delete_one",
"parameters": [
{
"name": "id",
"type": "str",
"description": "The ID of the document to delete.",
"default": null,
"value": null
},
{
"name": "timeout_info",
... |
astrapy.core.db.AsyncAstraDBCollection.delete_one_by_predicate | Delete a single document from the collection based on a filter clause | {
"kind": "function",
"name": "delete_one_by_predicate",
"path": "astrapy.core.db.AsyncAstraDBCollection.delete_one_by_predicate",
"parameters": [
{
"name": "filter",
"type": "dict[str, Any]",
"description": "any filter dictionary",
"default": null,
"value": null
},
{
... |
astrapy.core.db.AsyncAstraDBCollection.delete_many | Delete many documents from the collection based on a filter condition | {
"kind": "function",
"name": "delete_many",
"path": "astrapy.core.db.AsyncAstraDBCollection.delete_many",
"parameters": [
{
"name": "filter",
"type": "dict",
"description": "Criteria to identify the documents to delete.",
"default": null,
"value": null
},
{
"name... |
astrapy.core.db.AsyncAstraDBCollection.chunked_delete_many | Delete many documents from the collection based on a filter condition,
chaining several API calls until exhaustion of the documents to delete. | {
"kind": "function",
"name": "chunked_delete_many",
"path": "astrapy.core.db.AsyncAstraDBCollection.chunked_delete_many",
"parameters": [
{
"name": "filter",
"type": "dict",
"description": "Criteria to identify the documents to delete.",
"default": null,
"value": null
},
... |
astrapy.core.db.AsyncAstraDBCollection.clear | Clear the collection, deleting all documents | {
"kind": "function",
"name": "clear",
"path": "astrapy.core.db.AsyncAstraDBCollection.clear",
"parameters": [
{
"name": "timeout_info",
"type": "TimeoutInfoWideType",
"description": "a float, or a TimeoutInfo dict, for the HTTP request.\nNote that a 'read' timeout event will not block the... |
astrapy.core.db.AsyncAstraDBCollection.delete_subdocument | Delete a subdocument or field from a document in the collection. | {
"kind": "function",
"name": "delete_subdocument",
"path": "astrapy.core.db.AsyncAstraDBCollection.delete_subdocument",
"parameters": [
{
"name": "id",
"type": "str",
"description": "The ID of the document containing the subdocument.",
"default": null,
"value": null
},
... |
astrapy.core.db.AsyncAstraDBCollection.upsert_one | Emulate an upsert operation for a single document in the collection.
This method attempts to insert the document.
If a document with the same _id exists, it updates the existing document. | {
"kind": "function",
"name": "upsert_one",
"path": "astrapy.core.db.AsyncAstraDBCollection.upsert_one",
"parameters": [
{
"name": "document",
"type": "dict",
"description": "The document to insert or update.",
"default": null,
"value": null
},
{
"name": "timeout_... |
astrapy.core.db.AsyncAstraDBCollection.upsert_many | Emulate an upsert operation for multiple documents in the collection.
This method attempts to insert the documents.
If a document with the same _id exists, it updates the existing document. | {
"kind": "function",
"name": "upsert_many",
"path": "astrapy.core.db.AsyncAstraDBCollection.upsert_many",
"parameters": [
{
"name": "documents",
"type": "List[dict]",
"description": "The documents to insert or update.",
"default": null,
"value": null
},
{
"name":... |
astrapy.core.db.AstraDB | {
"kind": "class",
"name": "AstraDB",
"path": "astrapy.core.db.AstraDB",
"parameters": [
{
"name": "token",
"type": "str | None",
"description": null,
"default": null,
"value": null
},
{
"name": "api_endpoint",
"type": "str",
"description": null,
... | |
astrapy.core.db.AstraDB.client | {
"kind": "attribute",
"name": "client",
"path": "astrapy.core.db.AstraDB.client",
"parameters": null,
"returns": null,
"gathered_types": [
"Client"
],
"value": "client = httpx.Client()",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null... | |
astrapy.core.db.AstraDB.caller_name | {
"kind": "attribute",
"name": "caller_name",
"path": "astrapy.core.db.AstraDB.caller_name",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "caller_name = caller_name",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
... |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.