From 6e9b9d587aaacfb0ea39cdd66518d3f4bb725439 Mon Sep 17 00:00:00 2001 From: Alex Petenchea Date: Sun, 21 Dec 2025 00:15:31 +0800 Subject: [PATCH] URL fix --- README.md | 2 +- arangoasync/aql.py | 38 +++---- arangoasync/backup.py | 12 +-- arangoasync/cluster.py | 24 ++--- arangoasync/collection.py | 90 ++++++++--------- arangoasync/cursor.py | 6 +- arangoasync/database.py | 198 ++++++++++++++++++------------------- arangoasync/foxx.py | 42 ++++---- arangoasync/graph.py | 38 +++---- arangoasync/job.py | 10 +- arangoasync/replication.py | 14 +-- arangoasync/typings.py | 48 ++++----- arangoasync/version.py | 2 +- docs/certificates.rst | 2 +- docs/overview.rst | 2 +- docs/view.rst | 4 +- 16 files changed, 266 insertions(+), 266 deletions(-) diff --git a/README.md b/README.md index 1232efa..e35c413 100644 --- a/README.md +++ b/README.md @@ -75,7 +75,7 @@ async def main(): student_names.append(doc["name"]) ``` -Another example with [graphs](https://docs.arango.ai/stable/graphs/): +Another example with [graphs](https://docs.arango.ai/arangodb/stable/graphs/): ```python async def main(): diff --git a/arangoasync/aql.py b/arangoasync/aql.py index ec8efe4..ea57b75 100644 --- a/arangoasync/aql.py +++ b/arangoasync/aql.py @@ -78,7 +78,7 @@ async def entries(self) -> Result[Jsons]: AQLCacheEntriesError: If retrieval fails. References: - - `list-the-entries-of-the-aql-query-results-cache `__ + - `list-the-entries-of-the-aql-query-results-cache `__ """ # noqa: E501 request = Request(method=Method.GET, endpoint="/_api/query-cache/entries") @@ -99,7 +99,7 @@ async def plan_entries(self) -> Result[Jsons]: AQLCacheEntriesError: If retrieval fails. References: - - `list-the-entries-of-the-aql-query-plan-cache `__ + - `list-the-entries-of-the-aql-query-plan-cache `__ """ # noqa: E501 request = Request(method=Method.GET, endpoint="/_api/query-plan-cache") @@ -117,7 +117,7 @@ async def clear(self) -> Result[None]: AQLCacheClearError: If clearing the cache fails. References: - - `clear-the-aql-query-results-cache `__ + - `clear-the-aql-query-results-cache `__ """ # noqa: E501 request = Request(method=Method.DELETE, endpoint="/_api/query-cache") @@ -134,7 +134,7 @@ async def clear_plan(self) -> Result[None]: AQLCacheClearError: If clearing the cache fails. References: - - `clear-the-aql-query-plan-cache `__ + - `clear-the-aql-query-plan-cache `__ """ # noqa: E501 request = Request(method=Method.DELETE, endpoint="/_api/query-plan-cache") @@ -154,7 +154,7 @@ async def properties(self) -> Result[QueryCacheProperties]: AQLCachePropertiesError: If retrieval fails. References: - - `get-the-aql-query-results-cache-configuration `__ + - `get-the-aql-query-results-cache-configuration `__ """ # noqa: E501 request = Request(method=Method.GET, endpoint="/_api/query-cache/properties") @@ -193,7 +193,7 @@ async def configure( AQLCacheConfigureError: If setting the configuration fails. References: - - `set-the-aql-query-results-cache-configuration `__ + - `set-the-aql-query-results-cache-configuration `__ """ # noqa: E501 data: Json = dict() if mode is not None: @@ -298,7 +298,7 @@ async def execute( Cursor: Result cursor. References: - - `create-a-cursor `__ + - `create-a-cursor `__ """ # noqa: E501 data: Json = dict(query=query) if count is not None: @@ -353,7 +353,7 @@ async def tracking(self) -> Result[QueryTrackingConfiguration]: AQLQueryTrackingGetError: If retrieval fails. References: - - `get-the-aql-query-tracking-configuration `__ + - `get-the-aql-query-tracking-configuration `__ """ # noqa: E501 request = Request(method=Method.GET, endpoint="/_api/query/properties") @@ -397,7 +397,7 @@ async def set_tracking( AQLQueryTrackingSetError: If setting the configuration fails. References: - - `update-the-aql-query-tracking-configuration `__ + - `update-the-aql-query-tracking-configuration `__ """ # noqa: E501 data: Json = dict() @@ -462,7 +462,7 @@ async def queries(self, all_queries: bool = False) -> Result[Jsons]: AQLQueryListError: If retrieval fails. References: - - `list-the-running-queries `__ + - `list-the-running-queries `__ """ # noqa: E501 request = Request( method=Method.GET, @@ -493,7 +493,7 @@ async def slow_queries(self, all_queries: bool = False) -> Result[Jsons]: AQLQueryListError: If retrieval fails. References: - - `list-the-slow-aql-queries `__ + - `list-the-slow-aql-queries `__ """ # noqa: E501 request = Request( method=Method.GET, @@ -523,7 +523,7 @@ async def clear_slow_queries(self, all_queries: bool = False) -> Result[None]: AQLQueryClearError: If retrieval fails. References: - - `clear-the-list-of-slow-aql-queries `__ + - `clear-the-list-of-slow-aql-queries `__ """ # noqa: E501 request = Request( method=Method.DELETE, @@ -560,7 +560,7 @@ async def kill( AQLQueryKillError: If killing the query fails. References: - - `kill-a-running-aql-query `__ + - `kill-a-running-aql-query `__ """ # noqa: E501 request = Request( method=Method.DELETE, @@ -598,7 +598,7 @@ async def explain( AQLQueryExplainError: If retrieval fails. References: - - `explain-an-aql-query `__ + - `explain-an-aql-query `__ """ # noqa: E501 data: Json = dict(query=query) if bind_vars is not None: @@ -634,7 +634,7 @@ async def validate(self, query: str) -> Result[Json]: AQLQueryValidateError: If validation fails. References: - - `parse-an-aql-query `__ + - `parse-an-aql-query `__ """ # noqa: E501 request = Request( method=Method.POST, @@ -659,7 +659,7 @@ async def query_rules(self) -> Result[Jsons]: AQLQueryRulesGetError: If retrieval fails. References: - - `list-all-aql-optimizer-rules `__ + - `list-all-aql-optimizer-rules `__ """ # noqa: E501 request = Request(method=Method.GET, endpoint="/_api/query/rules") @@ -684,7 +684,7 @@ async def functions(self, namespace: Optional[str] = None) -> Result[Jsons]: AQLFunctionListError: If retrieval fails. References: - - `list-the-registered-user-defined-aql-functions `__ + - `list-the-registered-user-defined-aql-functions `__ """ # noqa: E501 params: Json = dict() if namespace is not None: @@ -726,7 +726,7 @@ async def create_function( AQLFunctionCreateError: If registration fails. References: - - `create-a-user-defined-aql-function `__ + - `create-a-user-defined-aql-function `__ """ # noqa: E501 request = Request( method=Method.POST, @@ -765,7 +765,7 @@ async def delete_function( AQLFunctionDeleteError: If removal fails. References: - - `remove-a-user-defined-aql-function `__ + - `remove-a-user-defined-aql-function `__ """ # noqa: E501 params: Json = dict() if group is not None: diff --git a/arangoasync/backup.py b/arangoasync/backup.py index e0847e0..7be69cd 100644 --- a/arangoasync/backup.py +++ b/arangoasync/backup.py @@ -49,7 +49,7 @@ async def get(self, backup_id: Optional[str] = None) -> Result[Json]: BackupGetError: If the operation fails. References: - - `list-backups `__ + - `list-backups `__ """ # noqa: E501 data: Json = {} if backup_id is not None: @@ -97,7 +97,7 @@ async def create( BackupCreateError: If the backup creation fails. References: - - `create-backup `__ + - `create-backup `__ """ # noqa: E501 data: Json = {} if label is not None: @@ -137,7 +137,7 @@ async def restore(self, backup_id: str) -> Result[Json]: BackupRestoreError: If the restore operation fails. References: - - `restore-backup `__ + - `restore-backup `__ """ # noqa: E501 data: Json = {"id": backup_id} request = Request( @@ -165,7 +165,7 @@ async def delete(self, backup_id: str) -> None: BackupDeleteError: If the delete operation fails. References: - - `delete-backup `__ + - `delete-backup `__ """ # noqa: E501 data: Json = {"id": backup_id} request = Request( @@ -209,7 +209,7 @@ async def upload( BackupUploadError: If upload operation fails. References: - - `upload-a-backup-to-a-remote-repository `__ + - `upload-a-backup-to-a-remote-repository `__ """ # noqa: E501 data: Json = {} if upload_id is not None: @@ -265,7 +265,7 @@ async def download( BackupDownloadError: If the download operation fails. References: - - `download-a-backup-from-a-remote-repository `__ + - `download-a-backup-from-a-remote-repository `__ """ # noqa: E501 data: Json = {} if download_id is not None: diff --git a/arangoasync/cluster.py b/arangoasync/cluster.py index 39e3d56..fa42ea3 100644 --- a/arangoasync/cluster.py +++ b/arangoasync/cluster.py @@ -45,7 +45,7 @@ async def health(self) -> Result[Json]: ClusterHealthError: If retrieval fails. References: - - `get-the-cluster-health `__ + - `get-the-cluster-health `__ """ # noqa: E501 request = Request( method=Method.GET, @@ -74,7 +74,7 @@ async def statistics(self, db_server: str) -> Result[Json]: ClusterStatisticsError: If retrieval fails. References: - - `get-the-statistics-of-a-db-server `__ + - `get-the-statistics-of-a-db-server `__ """ # noqa: E501 params: Params = {"DBserver": db_server} @@ -103,7 +103,7 @@ async def endpoints(self) -> Result[List[str]]: ClusterEndpointsError: If retrieval fails. References: - - `list-all-coordinator-endpoints `__ + - `list-all-coordinator-endpoints `__ """ # noqa: E501 request = Request( method=Method.GET, @@ -129,7 +129,7 @@ async def server_id(self) -> Result[str]: ClusterServerIDError: If retrieval fails. References: - - `get-the-server-id `__ + - `get-the-server-id `__ """ # noqa: E501 request = Request( method=Method.GET, @@ -154,7 +154,7 @@ async def server_role(self) -> Result[str]: ClusterServerRoleError: If retrieval fails. References: - - `get-the-server-role `__ + - `get-the-server-role `__ """ # noqa: E501 request = Request( method=Method.GET, @@ -182,7 +182,7 @@ async def toggle_maintenance_mode(self, mode: str) -> Result[Json]: ClusterMaintenanceModeError: If the toggle operation fails. References: - - `toggle-cluster-maintenance-mode `__ + - `toggle-cluster-maintenance-mode `__ """ # noqa: E501 request = Request( method=Method.PUT, @@ -212,7 +212,7 @@ async def server_maintenance_mode(self, server_id: str) -> Result[Json]: ClusterMaintenanceModeError: If retrieval fails. References: - - `get-the-maintenance-status-of-a-db-server `__ + - `get-the-maintenance-status-of-a-db-server `__ """ # noqa: E501 request = Request( method=Method.GET, @@ -242,7 +242,7 @@ async def toggle_server_maintenance_mode( ClusterMaintenanceModeError: If the operation fails. References: - - `set-the-maintenance-status-of-a-db-server `__ + - `set-the-maintenance-status-of-a-db-server `__ """ # noqa: E501 data: Json = {"mode": mode} if timeout is not None: @@ -271,7 +271,7 @@ async def calculate_imbalance(self) -> Result[Json]: ClusterRebalanceError: If retrieval fails. References: - - `get-the-current-cluster-imbalance `__ + - `get-the-current-cluster-imbalance `__ """ # noqa: E501 request = Request(method=Method.GET, endpoint="/_admin/cluster/rebalance") @@ -315,7 +315,7 @@ async def calculate_rebalance_plan( ClusterRebalanceError: If retrieval fails. References: - - `compute-a-set-of-move-shard-operations-to-improve-balance `__ + - `compute-a-set-of-move-shard-operations-to-improve-balance `__ """ # noqa: E501 data: Json = dict(version=version) if databases_excluded is not None: @@ -380,7 +380,7 @@ async def rebalance( ClusterRebalanceError: If retrieval fails. References: - - `compute-and-execute-a-set-of-move-shard-operations-to-improve-balance `__ + - `compute-and-execute-a-set-of-move-shard-operations-to-improve-balance `__ """ # noqa: E501 data: Json = dict(version=version) if databases_excluded is not None: @@ -431,7 +431,7 @@ async def execute_rebalance_plan( ClusterRebalanceError: If the execution fails. References: - - `execute-a-set-of-move-shard-operations `__ + - `execute-a-set-of-move-shard-operations `__ """ # noqa: E501 data: Json = dict(version=version, moves=moves) diff --git a/arangoasync/collection.py b/arangoasync/collection.py index fae501a..cc372bf 100644 --- a/arangoasync/collection.py +++ b/arangoasync/collection.py @@ -333,7 +333,7 @@ async def indexes( IndexListError: If retrieval fails. References: - - `list-all-indexes-of-a-collection `__ + - `list-all-indexes-of-a-collection `__ """ # noqa: E501 params: Params = dict(collection=self._name) if with_stats is not None: @@ -368,7 +368,7 @@ async def get_index(self, id: str | int) -> Result[IndexProperties]: IndexGetError: If retrieval fails. References: - `get-an-index `__ + `get-an-index `__ """ # noqa: E501 if isinstance(id, int): full_id = f"{self._name}/{id}" @@ -408,12 +408,12 @@ async def add_index( IndexCreateError: If index creation fails. References: - - `create-an-index `__ - - `create-a-persistent-index `__ - - `create-an-inverted-index `__ - - `create-a-ttl-index `__ - - `create-a-multi-dimensional-index `__ - - `create-a-geo-spatial-index `__ + - `create-an-index `__ + - `create-a-persistent-index `__ + - `create-an-inverted-index `__ + - `create-a-ttl-index `__ + - `create-a-multi-dimensional-index `__ + - `create-a-geo-spatial-index `__ """ # noqa: E501 options = options or {} request = Request( @@ -447,7 +447,7 @@ async def delete_index( IndexDeleteError: If deletion fails. References: - - `delete-an-index `__ + - `delete-an-index `__ """ # noqa: E501 if isinstance(id, int): full_id = f"{self._name}/{id}" @@ -478,7 +478,7 @@ async def load_indexes(self) -> Result[bool]: IndexLoadError: If loading fails. References: - - `load-collection-indexes-into-memory `__ + - `load-collection-indexes-into-memory `__ """ # noqa: E501 request = Request( method=Method.PUT, @@ -499,7 +499,7 @@ async def recalculate_count(self) -> None: CollectionRecalculateCountError: If re-calculation fails. References: - - `recalculate-the-document-count-of-a-collection `__ + - `recalculate-the-document-count-of-a-collection `__ """ # noqa: E501 request = Request( method=Method.PUT, @@ -522,7 +522,7 @@ async def properties(self) -> Result[CollectionProperties]: CollectionPropertiesError: If retrieval fails. References: - - `get-the-properties-of-a-collection `__ + - `get-the-properties-of-a-collection `__ """ # noqa: E501 request = Request( method=Method.GET, @@ -572,7 +572,7 @@ async def configure( CollectionConfigureError: If configuration fails. References: - - `change-the-properties-of-a-collection `__ + - `change-the-properties-of-a-collection `__ """ # noqa: E501 data: Json = {} if cache_enabled is not None: @@ -617,7 +617,7 @@ async def rename(self, new_name: str) -> None: CollectionRenameError: If rename fails. References: - - `rename-a-collection `__ + - `rename-a-collection `__ """ # noqa: E501 data: Json = {"name": new_name} request = Request( @@ -644,7 +644,7 @@ async def compact(self) -> Result[CollectionInfo]: CollectionCompactError: If compaction fails. References: - - `compact-a-collection `__ + - `compact-a-collection `__ """ # noqa: E501 request = Request( method=Method.PUT, @@ -677,7 +677,7 @@ async def truncate( CollectionTruncateError: If truncation fails. References: - - `truncate-a-collection `__ + - `truncate-a-collection `__ """ # noqa: E501 params: Params = {} if wait_for_sync is not None: @@ -707,7 +707,7 @@ async def count(self) -> Result[int]: DocumentCountError: If retrieval fails. References: - - `get-the-document-count-of-a-collection `__ + - `get-the-document-count-of-a-collection `__ """ # noqa: E501 request = Request( method=Method.GET, endpoint=f"/_api/collection/{self.name}/count" @@ -731,7 +731,7 @@ async def statistics(self) -> Result[CollectionStatistics]: CollectionStatisticsError: If retrieval fails. References: - - `get-the-collection-statistics `__ + - `get-the-collection-statistics `__ """ # noqa: E501 request = Request( method=Method.GET, @@ -761,7 +761,7 @@ async def responsible_shard(self, document: Json) -> Result[str]: CollectionResponsibleShardError: If retrieval fails. References: - - `get-the-responsible-shard-for-a-document `__ + - `get-the-responsible-shard-for-a-document `__ """ # noqa: E501 request = Request( method=Method.PUT, @@ -793,7 +793,7 @@ async def shards(self, details: Optional[bool] = None) -> Result[Json]: CollectionShardsError: If retrieval fails. References: - - `get-the-shard-ids-of-a-collection `__ + - `get-the-shard-ids-of-a-collection `__ """ # noqa: E501 params: Params = {} if details is not None: @@ -822,7 +822,7 @@ async def revision(self) -> Result[str]: CollectionRevisionError: If retrieval fails. References: - - `get-the-collection-revision-id `__ + - `get-the-collection-revision-id `__ """ # noqa: E501 request = Request( method=Method.GET, @@ -852,7 +852,7 @@ async def checksum( CollectionChecksumError: If retrieval fails. References: - - `get-the-collection-checksum `__ + - `get-the-collection-checksum `__ """ # noqa: E501 params: Params = {} if with_rev is not None: @@ -899,7 +899,7 @@ async def has( DocumentGetError: If retrieval fails. References: - - `get-a-document-header `__ + - `get-a-document-header `__ """ # noqa: E501 handle = self._get_doc_id(document) @@ -956,7 +956,7 @@ async def get_many( DocumentGetError: If retrieval fails. References: - - `get-multiple-documents `__ + - `get-multiple-documents `__ """ # noqa: E501 params: Params = {"onlyget": True} if ignore_revs is not None: @@ -1283,7 +1283,7 @@ async def insert_many( DocumentInsertError: If insertion fails. References: - - `create-multiple-documents `__ + - `create-multiple-documents `__ """ # noqa: E501 params: Params = {} if wait_for_sync is not None: @@ -1373,7 +1373,7 @@ async def replace_many( DocumentReplaceError: If replacing fails. References: - - `replace-multiple-documents `__ + - `replace-multiple-documents `__ """ # noqa: E501 params: Params = {} if wait_for_sync is not None: @@ -1466,7 +1466,7 @@ async def update_many( DocumentUpdateError: If update fails. References: - - `update-multiple-documents `__ + - `update-multiple-documents `__ """ # noqa: E501 params: Params = {} if wait_for_sync is not None: @@ -1548,7 +1548,7 @@ async def delete_many( DocumentRemoveError: If removal fails. References: - - `remove-multiple-documents `__ + - `remove-multiple-documents `__ """ # noqa: E501 params: Params = {} if wait_for_sync is not None: @@ -1640,7 +1640,7 @@ async def import_bulk( DocumentInsertError: If import fails. References: - - `import-json-data-as-documents `__ + - `import-json-data-as-documents `__ """ # noqa: E501 params: Params = dict() params["collection"] = self.name @@ -1730,7 +1730,7 @@ async def get( DocumentParseError: If the document is malformed. References: - - `get-a-document `__ + - `get-a-document `__ """ # noqa: E501 handle = self._get_doc_id(document) @@ -1818,7 +1818,7 @@ async def insert( DocumentParseError: If the document is malformed. References: - - `create-a-document `__ + - `create-a-document `__ """ # noqa: E501 if isinstance(document, dict): document = cast(T, self._ensure_key_from_id(document)) @@ -1923,7 +1923,7 @@ async def update( DocumentUpdateError: If update fails. References: - - `update-a-document `__ + - `update-a-document `__ """ # noqa: E501 params: Params = {} if ignore_revs is not None: @@ -2017,7 +2017,7 @@ async def replace( DocumentReplaceError: If replace fails. References: - - `replace-a-document `__ + - `replace-a-document `__ """ # noqa: E501 params: Params = {} if ignore_revs is not None: @@ -2105,7 +2105,7 @@ async def delete( DocumentDeleteError: If deletion fails. References: - - `remove-a-document `__ + - `remove-a-document `__ """ # noqa: E501 handle = self._get_doc_id(cast(str | Json, document)) @@ -2232,7 +2232,7 @@ async def get( DocumentParseError: If the document is malformed. References: - - `get-a-vertex `__ + - `get-a-vertex `__ """ # noqa: E501 handle = self._get_doc_id(vertex) @@ -2294,7 +2294,7 @@ async def insert( DocumentParseError: If the document is malformed. References: - - `create-a-vertex `__ + - `create-a-vertex `__ """ # noqa: E501 if isinstance(vertex, dict): vertex = cast(T, self._ensure_key_from_id(vertex)) @@ -2359,7 +2359,7 @@ async def update( DocumentUpdateError: If update fails. References: - - `update-a-vertex `__ + - `update-a-vertex `__ """ # noqa: E501 params: Params = {} if wait_for_sync is not None: @@ -2434,7 +2434,7 @@ async def replace( DocumentReplaceError: If replace fails. References: - - `replace-a-vertex `__ + - `replace-a-vertex `__ """ # noqa: E501 params: Params = {} if wait_for_sync is not None: @@ -2506,7 +2506,7 @@ async def delete( DocumentDeleteError: If deletion fails. References: - - `remove-a-vertex `__ + - `remove-a-vertex `__ """ # noqa: E501 params: Params = {} if wait_for_sync is not None: @@ -2631,7 +2631,7 @@ async def get( DocumentParseError: If the document is malformed. References: - - `get-an-edge `__ + - `get-an-edge `__ """ # noqa: E501 handle = self._get_doc_id(edge) @@ -2694,7 +2694,7 @@ async def insert( DocumentParseError: If the document is malformed. References: - - `create-an-edge `__ + - `create-an-edge `__ """ # noqa: E501 if isinstance(edge, dict): edge = cast(T, self._ensure_key_from_id(edge)) @@ -2763,7 +2763,7 @@ async def update( DocumentUpdateError: If update fails. References: - - `update-an-edge `__ + - `update-an-edge `__ """ # noqa: E501 params: Params = {} if wait_for_sync is not None: @@ -2842,7 +2842,7 @@ async def replace( DocumentReplaceError: If replace fails. References: - - `replace-an-edge `__ + - `replace-an-edge `__ """ # noqa: E501 params: Params = {} if wait_for_sync is not None: @@ -2917,7 +2917,7 @@ async def delete( DocumentDeleteError: If deletion fails. References: - - `remove-an-edge `__ + - `remove-an-edge `__ """ # noqa: E501 params: Params = {} if wait_for_sync is not None: @@ -2978,7 +2978,7 @@ async def edges( EdgeListError: If retrieval fails. References: - - `get-inbound-and-outbound-edges `__ + - `get-inbound-and-outbound-edges `__ """ # noqa: E501 params: Params = { "vertex": self._get_doc_id(vertex, validate=False), diff --git a/arangoasync/cursor.py b/arangoasync/cursor.py index 1e3cc6c..68ecdad 100644 --- a/arangoasync/cursor.py +++ b/arangoasync/cursor.py @@ -192,8 +192,8 @@ async def fetch(self, batch_id: Optional[str] = None) -> List[Any]: CursorStateError: If the cursor ID is not set. References: - - `read-the-next-batch-from-a-cursor `__ - - `read-a-batch-from-the-cursor-again `__ + - `read-the-next-batch-from-a-cursor `__ + - `read-a-batch-from-the-cursor-again `__ """ # noqa: E501 if self._id is None: raise CursorStateError("Cursor ID is not set") @@ -229,7 +229,7 @@ async def close(self, ignore_missing: bool = False) -> bool: CursorCloseError: If the cursor failed to close. References: - - `delete-a-cursor `__ + - `delete-a-cursor `__ """ # noqa: E501 if self._id is None: return False diff --git a/arangoasync/database.py b/arangoasync/database.py index 8e700e5..c1dc1b9 100644 --- a/arangoasync/database.py +++ b/arangoasync/database.py @@ -258,7 +258,7 @@ async def properties(self) -> Result[DatabaseProperties]: DatabasePropertiesError: If retrieval fails. References: - - `get-information-about-the-current-database `__ + - `get-information-about-the-current-database `__ """ # noqa: E501 request = Request(method=Method.GET, endpoint="/_api/database/current") @@ -281,7 +281,7 @@ async def status(self) -> Result[ServerStatusInformation]: ServerSatusError: If retrieval fails. References: - - `get-server-status-information `__ + - `get-server-status-information `__ """ # noqa: E501 request = Request(method=Method.GET, endpoint="/_admin/status") @@ -305,7 +305,7 @@ async def databases(self) -> Result[List[str]]: DatabaseListError: If retrieval fails. References: - - `list-all-databases `__ + - `list-all-databases `__ """ # noqa: E501 request = Request(method=Method.GET, endpoint="/_api/database") @@ -333,7 +333,7 @@ async def databases_accessible_to_user(self) -> Result[List[str]]: DatabaseListError: If retrieval fails. References: - - `list-the-accessible-databases `__ + - `list-the-accessible-databases `__ """ # noqa: E501 request = Request(method=Method.GET, endpoint="/_api/database/user") @@ -417,7 +417,7 @@ async def create_database( DatabaseCreateError: If creation fails. References: - - `create-a-database `__ + - `create-a-database `__ """ # noqa: E501 data: Json = {"name": name} @@ -478,7 +478,7 @@ async def delete_database( DatabaseDeleteError: If deletion fails. References: - - `drop-a-database `__ + - `drop-a-database `__ """ # noqa: E501 request = Request(method=Method.DELETE, endpoint=f"/_api/database/{name}") @@ -533,7 +533,7 @@ async def collections( CollectionListError: If retrieval fails. References: - - `list-all-collections `__ + - `list-all-collections `__ """ # noqa: E501 params: Params = {} if exclude_system is not None: @@ -661,7 +661,7 @@ async def create_collection( CollectionCreateError: If the operation fails. References: - - `create-a-collection `__ + - `create-a-collection `__ """ # noqa: E501 data: Json = {"name": name} if col_type is not None: @@ -751,7 +751,7 @@ async def delete_collection( CollectionDeleteError: If the operation fails. References: - - `drop-a-collection `__ + - `drop-a-collection `__ """ # noqa: E501 params: Params = {} if is_system is not None: @@ -782,7 +782,7 @@ async def key_generators(self) -> Result[List[str]]: CollectionKeyGeneratorsError: If retrieval fails. References: - - `get-the-available-key-generators `__ + - `get-the-available-key-generators `__ """ # noqa: E501 request = Request(method=Method.GET, endpoint="/_api/key-generators") @@ -821,7 +821,7 @@ async def has_document( DocumentGetError: If retrieval fails. References: - - `get-a-document-header `__ + - `get-a-document-header `__ """ # noqa: E501 col = Collection.get_col_name(document) return await self.collection(col).has( @@ -858,7 +858,7 @@ async def document( DocumentParseError: If the document is malformed. References: - - `get-a-document `__ + - `get-a-document `__ """ # noqa: E501 col: StandardCollection[Json, Json, Jsons] = self.collection( Collection.get_col_name(document) @@ -927,7 +927,7 @@ async def insert_document( DocumentParseError: If the document is malformed. References: - - `create-a-document `__ + - `create-a-document `__ """ # noqa: E501 col: StandardCollection[Json, Json, Jsons] = self.collection(collection) return await col.insert( @@ -998,7 +998,7 @@ async def update_document( DocumentUpdateError: If update fails. References: - - `update-a-document `__ + - `update-a-document `__ """ # noqa: E501 col: StandardCollection[Json, Json, Jsons] = self.collection( Collection.get_col_name(document) @@ -1063,7 +1063,7 @@ async def replace_document( DocumentReplaceError: If replace fails. References: - - `replace-a-document `__ + - `replace-a-document `__ """ # noqa: E501 col: StandardCollection[Json, Json, Jsons] = self.collection( Collection.get_col_name(document) @@ -1124,7 +1124,7 @@ async def delete_document( DocumentDeleteError: If deletion fails. References: - - `remove-a-document `__ + - `remove-a-document `__ """ # noqa: E501 col: StandardCollection[Json, Json, Jsons] = self.collection( Collection.get_col_name(document) @@ -1198,7 +1198,7 @@ async def graphs(self) -> Result[List[GraphProperties]]: GraphListError: If the operation fails. References: - - `list-all-graphs `__ + - `list-all-graphs `__ """ # noqa: E501 request = Request(method=Method.GET, endpoint="/_api/gharial") @@ -1253,7 +1253,7 @@ async def create_graph( GraphCreateError: If the operation fails. References: - - `create-a-graph `__ + - `create-a-graph `__ """ # noqa: E501 params: Params = {} if wait_for_sync is not None: @@ -1315,7 +1315,7 @@ async def delete_graph( GraphDeleteError: If the operation fails. References: - - `drop-a-graph `__ + - `drop-a-graph `__ """ # noqa: E501 params: Params = {} if drop_collections is not None: @@ -1347,8 +1347,8 @@ async def view(self, name: str) -> Result[Json]: ViewGetError: If the operation fails. References: - - `read-properties-of-a-view `__ - - `get-the-properties-of-a-view `__ + - `read-properties-of-a-view `__ + - `get-the-properties-of-a-view `__ """ # noqa: E501 request = Request(method=Method.GET, endpoint=f"/_api/view/{name}/properties") @@ -1372,8 +1372,8 @@ async def view_info(self, name: str) -> Result[Json]: ViewGetError: If the operation fails. References: - - `get-information-about-a-view `_ - - `get-information-about-a-view `__ + - `get-information-about-a-view `_ + - `get-information-about-a-view `__ """ # noqa: E501 request = Request(method=Method.GET, endpoint=f"/_api/view/{name}") @@ -1394,8 +1394,8 @@ async def views(self) -> Result[Jsons]: ViewListError: If the operation fails. References: - - `list-all-views `__ - - `list-all-views `__ + - `list-all-views `__ + - `list-all-views `__ """ # noqa: E501 request = Request(method=Method.GET, endpoint="/_api/view") @@ -1427,8 +1427,8 @@ async def create_view( ViewCreateError: If the operation fails. References: - - `create-a-search-alias-view `__ - - `create-an-arangosearch-view `__ + - `create-a-search-alias-view `__ + - `create-an-arangosearch-view `__ """ # noqa: E501 data: Json = {"name": name, "type": view_type} if properties is not None: @@ -1461,8 +1461,8 @@ async def replace_view(self, name: str, properties: Json) -> Result[Json]: ViewReplaceError: If the operation fails. References: - - `replace-the-properties-of-a-search-alias-view `__ - - `replace-the-properties-of-an-arangosearch-view `__ + - `replace-the-properties-of-a-search-alias-view `__ + - `replace-the-properties-of-an-arangosearch-view `__ """ # noqa: E501 request = Request( method=Method.PUT, @@ -1491,8 +1491,8 @@ async def update_view(self, name: str, properties: Json) -> Result[Json]: ViewUpdateError: If the operation fails. References: - - `update-the-properties-of-a-search-alias-view `__ - - `update-the-properties-of-an-arangosearch-view `__ + - `update-the-properties-of-a-search-alias-view `__ + - `update-the-properties-of-an-arangosearch-view `__ """ # noqa: E501 request = Request( method=Method.PATCH, @@ -1518,8 +1518,8 @@ async def rename_view(self, name: str, new_name: str) -> None: ViewRenameError: If the operation fails. References: - - `rename-a-view `__ - - `rename-a-view `__ + - `rename-a-view `__ + - `rename-a-view `__ """ # noqa: E501 request = Request( method=Method.PUT, @@ -1551,8 +1551,8 @@ async def delete_view( ViewDeleteError: If the operation fails. References: - - `drop-a-view `__ - - `drop-a-view `__ + - `drop-a-view `__ + - `drop-a-view `__ """ # noqa: E501 request = Request(method=Method.DELETE, endpoint=f"/_api/view/{name}") @@ -1575,7 +1575,7 @@ async def analyzers(self) -> Result[Jsons]: AnalyzerListError: If the operation fails. References: - - `list-all-analyzers `__ + - `list-all-analyzers `__ """ # noqa: E501 request = Request(method=Method.GET, endpoint="/_api/analyzer") @@ -1597,7 +1597,7 @@ async def analyzer(self, name: str) -> Result[Json]: dict: Analyzer properties. References: - - `get-an-analyzer-definition `__ + - `get-an-analyzer-definition `__ """ # noqa: E501 request = Request(method=Method.GET, endpoint=f"/_api/analyzer/{name}") @@ -1632,7 +1632,7 @@ async def create_analyzer( AnalyzerCreateError: If the operation fails. References: - - `create-an-analyzer `__ + - `create-an-analyzer `__ """ # noqa: E501 data: Json = {"name": name, "type": analyzer_type} if properties is not None: @@ -1671,7 +1671,7 @@ async def delete_analyzer( AnalyzerDeleteError: If the operation fails. References: - - `remove-an-analyzer `__ + - `remove-an-analyzer `__ """ # noqa: E501 params: Params = {} if force is not None: @@ -1728,7 +1728,7 @@ async def user(self, username: str) -> Result[UserInfo]: UserGetError: If the operation fails. References: - - `get-a-user` `__ + - `get-a-user` `__ """ # noqa: E501 request = Request(method=Method.GET, endpoint=f"/_api/user/{username}") @@ -1757,7 +1757,7 @@ async def users(self) -> Result[Sequence[UserInfo]]: UserListError: If the operation fails. References: - - `list-available-users `__ + - `list-available-users `__ """ # noqa: E501 request = Request(method=Method.GET, endpoint="/_api/user") @@ -1792,7 +1792,7 @@ async def create_user(self, user: UserInfo | Json) -> Result[UserInfo]: await db.create_user({user="john", password="secret"}) References: - - `create-a-user `__ + - `create-a-user `__ """ # noqa: E501 if isinstance(user, dict): user = UserInfo(**user) @@ -1832,7 +1832,7 @@ async def replace_user(self, user: UserInfo | Json) -> Result[UserInfo]: UserReplaceError: If the operation fails. References: - - `replace-a-user `__ + - `replace-a-user `__ """ # noqa: E501 if isinstance(user, dict): user = UserInfo(**user) @@ -1872,7 +1872,7 @@ async def update_user(self, user: UserInfo | Json) -> Result[UserInfo]: UserUpdateError: If the operation fails. References: - - `update-a-user `__ + - `update-a-user `__ """ # noqa: E501 if isinstance(user, dict): user = UserInfo(**user) @@ -1917,7 +1917,7 @@ async def delete_user( UserDeleteError: If the operation fails. References: - - `remove-a-user `__ + - `remove-a-user `__ """ # noqa: E501 request = Request(method=Method.DELETE, endpoint=f"/_api/user/{username}") @@ -1945,7 +1945,7 @@ async def permissions(self, username: str, full: bool = True) -> Result[Json]: PermissionListError: If the operation fails. References: - - `list-a-users-accessible-databases `__ + - `list-a-users-accessible-databases `__ """ # noqa: 501 request = Request( method=Method.GET, @@ -1981,8 +1981,8 @@ async def permission( PermissionGetError: If the operation fails. References: - - `get-a-users-database-access-level `__ - - `get-a-users-collection-access-level `__ + - `get-a-users-database-access-level `__ + - `get-a-users-collection-access-level `__ """ # noqa: 501 endpoint = f"/_api/user/{username}/database/{database}" if collection is not None: @@ -2022,8 +2022,8 @@ async def update_permission( is `False`. References: - - `set-a-users-database-access-level `__ - - `set-a-users-collection-access-level `__ + - `set-a-users-database-access-level `__ + - `set-a-users-collection-access-level `__ """ # noqa: E501 endpoint = f"/_api/user/{username}/database/{database}" if collection is not None: @@ -2067,8 +2067,8 @@ async def reset_permission( is `False`. References: - - `clear-a-users-database-access-level `__ - - `clear-a-users-collection-access-level `__ + - `clear-a-users-database-access-level `__ + - `clear-a-users-collection-access-level `__ """ # noqa: E501 endpoint = f"/_api/user/{username}/database/{database}" if collection is not None: @@ -2098,7 +2098,7 @@ async def jwt_secrets(self) -> Result[Json]: JWTSecretListError: If the operation fails. References: - - `get-information-about-the-loaded-jwt-secrets `__ + - `get-information-about-the-loaded-jwt-secrets `__ """ # noqa: 501 request = Request(method=Method.GET, endpoint="/_admin/server/jwt") @@ -2120,7 +2120,7 @@ async def reload_jwt_secrets(self) -> Result[Json]: JWTSecretReloadError: If the operation fails. References: - - `hot-reload-the-jwt-secrets-from-disk `__ + - `hot-reload-the-jwt-secrets-from-disk `__ """ # noqa: 501 request = Request( method=Method.POST, endpoint="/_admin/server/jwt", prefix_needed=False @@ -2155,7 +2155,7 @@ async def create_access_token( AccessTokenCreateError: If the operation fails. References: - - `create-an-access-token `__ + - `create-an-access-token `__ """ # noqa: E501 data: Json = { "name": name, @@ -2187,7 +2187,7 @@ async def delete_access_token(self, user: str, token_id: int) -> None: AccessTokenDeleteError: If the operation fails. References: - - `delete-an-access-token `__ + - `delete-an-access-token `__ """ # noqa: E501 request = Request( method=Method.DELETE, endpoint=f"/_api/token/{user}/{token_id}" @@ -2212,7 +2212,7 @@ async def list_access_tokens(self, user: str) -> Result[Jsons]: AccessTokenListError: If the operation fails. References: - - `list-all-access-tokens `__ + - `list-all-access-tokens `__ """ # noqa: E501 request = Request(method=Method.GET, endpoint=f"/_api/token/{user}") @@ -2238,7 +2238,7 @@ async def tls(self) -> Result[Json]: ServerTLSError: If the operation fails. References: - - `get-the-tls-data `__ + - `get-the-tls-data `__ """ # noqa: E501 request = Request(method=Method.GET, endpoint="/_admin/server/tls") @@ -2262,7 +2262,7 @@ async def reload_tls(self) -> Result[Json]: ServerTLSReloadError: If the operation fails. References: - - `reload-the-tls-data `__ + - `reload-the-tls-data `__ """ # noqa: E501 request = Request(method=Method.POST, endpoint="/_admin/server/tls") @@ -2287,7 +2287,7 @@ async def encryption(self) -> Result[Json]: ServerEncryptionError: If the operation fails. References: - - `rotate-the-encryption-keys `__ + - `rotate-the-encryption-keys `__ """ # noqa: E501 request = Request(method=Method.POST, endpoint="/_admin/server/encryption") @@ -2360,7 +2360,7 @@ async def execute_transaction( TransactionExecuteError: If the operation fails on the server side. References: - - `execute-a-javascript-transaction `__ + - `execute-a-javascript-transaction `__ """ # noqa: 501 m = "JavaScript Transactions are deprecated from ArangoDB v3.12.0 onward and will be removed in a future version." # noqa: E501 warn(m, DeprecationWarning, stacklevel=2) @@ -2411,7 +2411,7 @@ async def version(self, details: bool = False) -> Result[Json]: ServerVersionError: If the operation fails on the server side. References: - - `get-the-server-version `__ + - `get-the-server-version `__ """ # noqa: E501 request = Request( method=Method.GET, endpoint="/_api/version", params={"details": details} @@ -2434,7 +2434,7 @@ async def tasks(self) -> Result[Jsons]: TaskListError: If the list cannot be retrieved. References: - - `list-all-tasks `__ + - `list-all-tasks `__ """ # noqa: E501 request = Request(method=Method.GET, endpoint="/_api/tasks") @@ -2459,7 +2459,7 @@ async def task(self, task_id: str) -> Result[Json]: TaskGetError: If the task details cannot be retrieved. References: - - `get-a-task `__ + - `get-a-task `__ """ # noqa: E501 request = Request(method=Method.GET, endpoint=f"/_api/tasks/{task_id}") @@ -2499,8 +2499,8 @@ async def create_task( TaskCreateError: If the task cannot be created. References: - - `create-a-task `__ - - `create-a-task-with-id `__ + - `create-a-task `__ + - `create-a-task-with-id `__ """ # noqa: E501 data: Json = {"command": command} if name is not None: @@ -2553,7 +2553,7 @@ async def delete_task( TaskDeleteError: If the operation fails. References: - - `delete-a-task `__ + - `delete-a-task `__ """ # noqa: E501 request = Request(method=Method.DELETE, endpoint=f"/_api/tasks/{task_id}") @@ -2576,7 +2576,7 @@ async def engine(self) -> Result[Json]: ServerEngineError: If the operation fails. References: - - `get-the-storage-engine-type `__ + - `get-the-storage-engine-type `__ """ # noqa: E501 request = Request(method=Method.GET, endpoint="/_api/engine") @@ -2598,7 +2598,7 @@ async def time(self) -> Result[datetime]: ServerTimeError: If the operation fails. References: - - `get-the-system-time `__ + - `get-the-system-time `__ """ # noqa: E501 request = Request(method=Method.GET, endpoint="/_admin/time") @@ -2621,7 +2621,7 @@ async def check_availability(self) -> Result[str]: ServerCheckAvailabilityError: If the operation fails. References: - - `check-server-availability `__ + - `check-server-availability `__ """ # noqa: E501 request = Request( method=Method.GET, @@ -2649,7 +2649,7 @@ async def support_info(self) -> Result[Json]: DatabaseSupportInfoError: If the operation fails. References: - - `get-information-about-the-deployment `__ + - `get-information-about-the-deployment `__ """ # noqa: E501 request = Request(method=Method.GET, endpoint="/_admin/support-info") @@ -2672,7 +2672,7 @@ async def options(self) -> Result[Json]: ServerCurrentOptionsGetError: If the operation fails. References: - - `get-the-startup-option-configuration `__ + - `get-the-startup-option-configuration `__ """ # noqa: E501 request = Request(method=Method.GET, endpoint="/_admin/options") @@ -2694,7 +2694,7 @@ async def options_available(self) -> Result[Json]: ServerAvailableOptionsGetError: If the operation fails. References: - - `get-the-available-startup-options `__ + - `get-the-available-startup-options `__ """ # noqa: E501 request = Request(method=Method.GET, endpoint="/_admin/options-description") @@ -2716,7 +2716,7 @@ async def mode(self) -> Result[str]: ServerModeError: If the operation fails. References: - - `return-whether-or-not-a-server-is-in-read-only-mode `__ + - `return-whether-or-not-a-server-is-in-read-only-mode `__ """ # noqa: E501 request = Request(method=Method.GET, endpoint="/_admin/server/mode") @@ -2740,7 +2740,7 @@ async def set_mode(self, mode: str) -> Result[str]: ServerModeSetError: If the operation fails. References: - - `set-the-server-mode-to-read-only-or-default `__ + - `set-the-server-mode-to-read-only-or-default `__ """ # noqa: E501 request = Request( method=Method.PUT, @@ -2766,7 +2766,7 @@ async def license(self) -> Result[Json]: ServerLicenseGetError: If the operation fails. References: - - `get-information-about-the-current-license `__ + - `get-information-about-the-current-license `__ """ # noqa: E501 request = Request(method=Method.GET, endpoint="/_admin/license") @@ -2790,7 +2790,7 @@ async def set_license(self, license: str, force: Optional[bool] = False) -> None ServerLicenseSetError: If the operation fails. References: - - `set-a-new-license `__ + - `set-a-new-license `__ """ # noqa: E501 params: Params = {} if force is not None: @@ -2819,7 +2819,7 @@ async def shutdown(self, soft: Optional[bool] = None) -> None: ServerShutdownError: If the operation fails. References: - - `start-the-shutdown-sequence `__ + - `start-the-shutdown-sequence `__ """ # noqa: E501 params: Params = {} if soft is not None: @@ -2847,7 +2847,7 @@ async def shutdown_progress(self) -> Result[Json]: ServerShutdownProgressError: If the operation fails. References: - - `query-the-soft-shutdown-progress `__ + - `query-the-soft-shutdown-progress `__ """ # noqa: E501 request = Request(method=Method.GET, endpoint="/_admin/shutdown") @@ -2884,7 +2884,7 @@ async def compact( DatabaseCompactError: If the operation fails. References: - - `compact-all-databases `__ + - `compact-all-databases `__ """ # noqa: E501 data = {} if change_level is not None: @@ -2911,7 +2911,7 @@ async def reload_routing(self) -> None: ServerReloadRoutingError: If the operation fails. References: - - `reload-the-routing-table `__ + - `reload-the-routing-table `__ """ # noqa: E501 request = Request(method=Method.POST, endpoint="/_admin/routing/reload") @@ -2934,7 +2934,7 @@ async def echo(self, body: Optional[Json] = None) -> Result[Json]: ServerEchoError: If the operation fails. References: - - `echo-a-request `__ + - `echo-a-request `__ """ # noqa: E501 data = body if body is not None else {} request = Request(method=Method.POST, endpoint="/_admin/echo", data=data) @@ -2960,7 +2960,7 @@ async def execute(self, command: str) -> Result[Any]: ServerExecuteError: If the execution fails. References: - - `execute-a-script `__ + - `execute-a-script `__ """ # noqa: E501 request = Request( method=Method.POST, endpoint="/_admin/execute", data=command.encode("utf-8") @@ -3002,7 +3002,7 @@ async def metrics(self, server_id: Optional[str] = None) -> Result[str]: ServerMetricsError: If the operation fails. References: - - `metrics-api-v2 `__ + - `metrics-api-v2 `__ """ # noqa: E501 params: Params = {} if server_id is not None: @@ -3058,7 +3058,7 @@ async def read_log_entries( ServerReadLogError: If the operation fails. References: - - `get-the-global-server-logs `__ + - `get-the-global-server-logs `__ """ # noqa: E501 params: Params = {} if upto is not None: @@ -3110,7 +3110,7 @@ async def log_levels( ServerLogLevelError: If the operation fails. References: - - `get-the-server-log-levels `__ + - `get-the-server-log-levels `__ """ # noqa: E501 params: Params = {} if server_id is not None: @@ -3166,7 +3166,7 @@ async def set_log_levels( ServerLogLevelSetError: If the operation fails. References: - - `set-the-structured-log-settings `__ + - `set-the-structured-log-settings `__ """ # noqa: E501 params: Params = {} if server_id is not None: @@ -3207,7 +3207,7 @@ async def reset_log_levels(self, server_id: Optional[str] = None) -> Result[Json ServerLogLevelResetError: If the operation fails. References: - - `reset-the-server-log-levels `__ + - `reset-the-server-log-levels `__ """ # noqa: E501 params: Params = {} if server_id is not None: @@ -3238,7 +3238,7 @@ async def log_settings(self) -> Result[Json]: ServerLogSettingError: If the operation fails. References: - - `get-the-structured-log-settings `__ + - `get-the-structured-log-settings `__ """ # noqa: E501 request = Request( method=Method.GET, @@ -3279,7 +3279,7 @@ async def set_log_settings(self, **kwargs: Dict[str, Any]) -> Result[Json]: ServerLogSettingSetError: If the operation fails. References: - - `set-the-structured-log-settings `__ + - `set-the-structured-log-settings `__ """ # noqa: E501 request = Request( method=Method.PUT, @@ -3306,7 +3306,7 @@ async def api_calls(self) -> Result[Json]: ServerApiCallsError: If the operation fails. References: - - `get-recent-api-calls `__ + - `get-recent-api-calls `__ """ # noqa: E501 request = Request( method=Method.GET, @@ -3379,7 +3379,7 @@ async def begin_transaction( TransactionInitError: If the operation fails on the server side. References: - - `begin-a-stream-transaction `__ + - `begin-a-stream-transaction `__ """ # noqa: E501 collections = dict() if read is not None: @@ -3463,7 +3463,7 @@ async def async_jobs( AsyncJobListError: If retrieval fails. References: - - `list-async-jobs-by-status-or-get-the-status-of-specific-job `__ + - `list-async-jobs-by-status-or-get-the-status-of-specific-job `__ """ # noqa: E501 params: Params = {} if count is not None: @@ -3496,7 +3496,7 @@ async def clear_async_jobs(self, threshold: Optional[float] = None) -> None: AsyncJobClearError: If the operation fails. References: - - `delete-async-job-results `__ + - `delete-async-job-results `__ """ # noqa: E501 if threshold is None: request = Request(method=Method.DELETE, endpoint="/_api/job/all") @@ -3516,7 +3516,7 @@ def response_handler(resp: Response) -> None: class TransactionDatabase(Database): """Database API tailored specifically for - `Stream Transactions `__. + `Stream Transactions `__. It allows you start a transaction, run multiple operations (eg. AQL queries) over a short period of time, and then commit or abort the transaction. @@ -3551,7 +3551,7 @@ async def transaction_status(self) -> str: TransactionStatusError: If the transaction is not found. References: - - `get-the-status-of-a-stream-transaction `__ + - `get-the-status-of-a-stream-transaction `__ """ # noqa: E501 request = Request( method=Method.GET, @@ -3573,7 +3573,7 @@ async def commit_transaction(self) -> None: TransactionCommitError: If the operation fails on the server side. References: - - `commit-a-stream-transaction `__ + - `commit-a-stream-transaction `__ """ # noqa: E501 request = Request( method=Method.PUT, @@ -3593,7 +3593,7 @@ async def abort_transaction(self) -> None: TransactionAbortError: If the operation fails on the server side. References: - - `abort-a-stream-transaction `__ + - `abort-a-stream-transaction `__ """ # noqa: E501 request = Request( method=Method.DELETE, @@ -3620,7 +3620,7 @@ class AsyncDatabase(Database): and no results are stored on server. References: - - `jobs `__ + - `jobs `__ """ # noqa: E501 def __init__(self, connection: Connection, return_result: bool) -> None: diff --git a/arangoasync/foxx.py b/arangoasync/foxx.py index fe02b41..0b068da 100644 --- a/arangoasync/foxx.py +++ b/arangoasync/foxx.py @@ -65,7 +65,7 @@ async def services(self, exclude_system: Optional[bool] = False) -> Result[Jsons FoxxServiceListError: If retrieval fails. References: - - `list-the-installed-services `__ + - `list-the-installed-services `__ """ # noqa: E501 params: Params = {} if exclude_system is not None: @@ -98,7 +98,7 @@ async def service(self, mount: str) -> Result[Json]: FoxxServiceGetError: If retrieval fails. References: - - `get-the-service-description `__ + - `get-the-service-description `__ """ # noqa: E501 params: Params = {"mount": mount} request = Request( @@ -142,7 +142,7 @@ async def create_service( FoxxServiceCreateError: If installation fails. References: - - `install-a-new-service-mode `__ + - `install-a-new-service-mode `__ """ # noqa: E501 params: Params = dict() params["mount"] = mount @@ -189,7 +189,7 @@ async def delete_service( FoxxServiceDeleteError: If operations fails. References: - - `uninstall-a-service `__ + - `uninstall-a-service `__ """ # noqa: E501 params: Params = dict() params["mount"] = mount @@ -236,7 +236,7 @@ async def replace_service( FoxxServiceReplaceError: If replacement fails. References: - - `replace-a-service `__ + - `replace-a-service `__ """ # noqa: E501 params: Params = dict() params["mount"] = mount @@ -298,7 +298,7 @@ async def update_service( FoxxServiceUpdateError: If upgrade fails. References: - - `upgrade-a-service `__ + - `upgrade-a-service `__ """ # noqa: E501 params: Params = dict() params["mount"] = mount @@ -345,7 +345,7 @@ async def config(self, mount: str) -> Result[Json]: FoxxConfigGetError: If retrieval fails. References: - - `get-the-configuration-options `__ + - `get-the-configuration-options `__ """ # noqa: E501 request = Request( method=Method.GET, @@ -375,7 +375,7 @@ async def update_config(self, mount: str, options: Json) -> Result[Json]: FoxxConfigUpdateError: If update fails. References: - - `update-the-configuration-options `__ + - `update-the-configuration-options `__ """ # noqa: E501 request = Request( method=Method.PATCH, @@ -407,7 +407,7 @@ async def replace_config(self, mount: str, options: Json) -> Result[Json]: FoxxConfigReplaceError: If replace fails. References: - - `replace-the-configuration-options `__ + - `replace-the-configuration-options `__ """ # noqa: E501 request = Request( method=Method.PUT, @@ -437,7 +437,7 @@ async def dependencies(self, mount: str) -> Result[Json]: FoxxDependencyGetError: If retrieval fails. References: - - `get-the-dependency-options `__ + - `get-the-dependency-options `__ """ # noqa: E501 request = Request( method=Method.GET, @@ -467,7 +467,7 @@ async def update_dependencies(self, mount: str, options: Json) -> Result[Json]: FoxxDependencyUpdateError: If update fails. References: - - `update-the-dependency-options `__ + - `update-the-dependency-options `__ """ # noqa: E501 request = Request( method=Method.PATCH, @@ -498,7 +498,7 @@ async def replace_dependencies(self, mount: str, options: Json) -> Result[Json]: FoxxDependencyReplaceError: If replace fails. References: - - `replace-the-dependency-options `__ + - `replace-the-dependency-options `__ """ # noqa: E501 request = Request( method=Method.PUT, @@ -528,7 +528,7 @@ async def scripts(self, mount: str) -> Result[Json]: FoxxScriptListError: If retrieval fails. References: - - `list-the-service-scripts `__ + - `list-the-service-scripts `__ """ # noqa: E501 request = Request( method=Method.GET, @@ -561,7 +561,7 @@ async def run_script( FoxxScriptRunError: If script fails. References: - - `run-a-service-script `__ + - `run-a-service-script `__ """ # noqa: E501 request = Request( method=Method.POST, @@ -612,7 +612,7 @@ async def run_tests( FoxxTestRunError: If test fails. References: - - `run-the-service-tests `__ + - `run-the-service-tests `__ """ # noqa: E501 params: Params = dict() params["mount"] = mount @@ -665,7 +665,7 @@ async def enable_development(self, mount: str) -> Result[Json]: FoxxDevModeEnableError: If the operation fails. References: - - `enable-the-development-mode `__ + - `enable-the-development-mode `__ """ # noqa: E501 request = Request( method=Method.POST, @@ -697,7 +697,7 @@ async def disable_development(self, mount: str) -> Result[Json]: FoxxDevModeDisableError: If the operation fails. References: - - `disable-the-development-mode `__ + - `disable-the-development-mode `__ """ # noqa: E501 request = Request( method=Method.DELETE, @@ -726,7 +726,7 @@ async def readme(self, mount: str) -> Result[str]: FoxxReadmeGetError: If retrieval fails. References: - - `get-the-service-readme `__ + - `get-the-service-readme `__ """ # noqa: E501 request = Request( method=Method.GET, @@ -754,7 +754,7 @@ async def swagger(self, mount: str) -> Result[Json]: FoxxSwaggerGetError: If retrieval fails. References: - - `get-the-swagger-description `__ + - `get-the-swagger-description `__ """ # noqa: E501 request = Request( method=Method.GET, endpoint="/_api/foxx/swagger", params={"mount": mount} @@ -785,7 +785,7 @@ async def download(self, mount: str) -> Result[bytes]: FoxxDownloadError: If download fails. References: - - `download-a-service-bundle `__ + - `download-a-service-bundle `__ """ # noqa: E501 request = Request( method=Method.POST, endpoint="/_api/foxx/download", params={"mount": mount} @@ -812,7 +812,7 @@ async def commit(self, replace: Optional[bool] = None) -> None: FoxxCommitError: If commit fails. References: - - `commit-the-local-service-state `__ + - `commit-the-local-service-state `__ """ # noqa: E501 params: Params = {} if replace is not None: diff --git a/arangoasync/graph.py b/arangoasync/graph.py index dbb9732..1fba982 100644 --- a/arangoasync/graph.py +++ b/arangoasync/graph.py @@ -93,7 +93,7 @@ async def properties(self) -> Result[GraphProperties]: GraphProperties: If the operation fails. References: - - `get-a-graph `__ + - `get-a-graph `__ """ # noqa: E501 request = Request(method=Method.GET, endpoint=f"/_api/gharial/{self._name}") @@ -132,7 +132,7 @@ async def vertex_collections(self) -> Result[List[str]]: VertexCollectionListError: If the operation fails. References: - - `list-vertex-collections `__ + - `list-vertex-collections `__ """ # noqa: E501 request = Request( method=Method.GET, @@ -191,7 +191,7 @@ async def create_vertex_collection( VertexCollectionCreateError: If the operation fails. References: - - `add-a-vertex-collection `__ + - `add-a-vertex-collection `__ """ # noqa: E501 data: Json = {"collection": name} @@ -228,7 +228,7 @@ async def delete_vertex_collection(self, name: str, purge: bool = False) -> None VertexCollectionDeleteError: If the operation fails. References: - - `remove-a-vertex-collection `__ + - `remove-a-vertex-collection `__ """ # noqa: E501 request = Request( method=Method.DELETE, @@ -300,7 +300,7 @@ async def vertex( DocumentParseError: If the document is malformed. References: - - `get-a-vertex `__ + - `get-a-vertex `__ """ # noqa: E501 col = Collection.get_col_name(vertex) return await self.vertex_collection(col).get( @@ -337,7 +337,7 @@ async def insert_vertex( DocumentParseError: If the document is malformed. References: - - `create-a-vertex `__ + - `create-a-vertex `__ """ # noqa: E501 return await self.vertex_collection(collection).insert( vertex, @@ -379,7 +379,7 @@ async def update_vertex( DocumentUpdateError: If update fails. References: - - `update-a-vertex `__ + - `update-a-vertex `__ """ # noqa: E501 col = Collection.get_col_name(cast(Json | str, vertex)) return await self.vertex_collection(col).update( @@ -425,7 +425,7 @@ async def replace_vertex( DocumentReplaceError: If replace fails. References: - - `replace-a-vertex `__ + - `replace-a-vertex `__ """ # noqa: E501 col = Collection.get_col_name(cast(Json | str, vertex)) return await self.vertex_collection(col).replace( @@ -468,7 +468,7 @@ async def delete_vertex( DocumentDeleteError: If deletion fails. References: - - `remove-a-vertex `__ + - `remove-a-vertex `__ """ # noqa: E501 col = Collection.get_col_name(cast(Json | str, vertex)) return await self.vertex_collection(col).delete( @@ -551,7 +551,7 @@ async def edge_collections(self) -> Result[List[str]]: EdgeCollectionListError: If the operation fails. References: - - `list-edge-collections `__ + - `list-edge-collections `__ """ # noqa: E501 request = Request( method=Method.GET, @@ -602,7 +602,7 @@ async def create_edge_definition( EdgeDefinitionCreateError: If the operation fails. References: - - `add-an-edge-definition `__ + - `add-an-edge-definition `__ """ # noqa: E501 data: Json = { "collection": edge_collection, @@ -659,7 +659,7 @@ async def replace_edge_definition( EdgeDefinitionReplaceError: If the operation fails. References: - - `replace-an-edge-definition `__ + - `replace-an-edge-definition `__ """ # noqa: E501 data: Json = { "collection": edge_collection, @@ -712,7 +712,7 @@ async def delete_edge_definition( EdgeDefinitionDeleteError: If the operation fails. References: - - `remove-an-edge-definition `__ + - `remove-an-edge-definition `__ """ # noqa: E501 params: Params = {} if drop_collections is not None: @@ -793,7 +793,7 @@ async def edge( DocumentParseError: If the document is malformed. References: - - `get-an-edge `__ + - `get-an-edge `__ """ # noqa: E501 col = Collection.get_col_name(edge) return await self.edge_collection(col).get( @@ -832,7 +832,7 @@ async def insert_edge( DocumentParseError: If the document is malformed. References: - - `create-an-edge `__ + - `create-an-edge `__ """ # noqa: E501 return await self.edge_collection(collection).insert( edge, @@ -875,7 +875,7 @@ async def update_edge( DocumentUpdateError: If update fails. References: - - `update-an-edge `__ + - `update-an-edge `__ """ # noqa: E501 col = Collection.get_col_name(cast(Json | str, edge)) return await self.edge_collection(col).update( @@ -923,7 +923,7 @@ async def replace_edge( DocumentReplaceError: If replace fails. References: - - `replace-an-edge `__ + - `replace-an-edge `__ """ # noqa: E501 col = Collection.get_col_name(cast(Json | str, edge)) return await self.edge_collection(col).replace( @@ -967,7 +967,7 @@ async def delete_edge( DocumentDeleteError: If deletion fails. References: - - `remove-an-edge `__ + - `remove-an-edge `__ """ # noqa: E501 col = Collection.get_col_name(cast(Json | str, edge)) return await self.edge_collection(col).delete( @@ -1001,7 +1001,7 @@ async def edges( EdgeListError: If retrieval fails. References: - - `get-inbound-and-outbound-edges `__ + - `get-inbound-and-outbound-edges `__ """ # noqa: E501 return await self.edge_collection(collection).edges( vertex, diff --git a/arangoasync/job.py b/arangoasync/job.py index 9f64764..bec3c6a 100644 --- a/arangoasync/job.py +++ b/arangoasync/job.py @@ -27,7 +27,7 @@ class AsyncJob(Generic[T]): response_handler: HTTP response handler References: - - `jobs `__ + - `jobs `__ """ # noqa: E501 def __init__( @@ -68,7 +68,7 @@ async def status(self) -> str: AsyncJobStatusError: If retrieval fails or the job is not found. References: - - `list-async-jobs-by-status-or-get-the-status-of-specific-job `__ + - `list-async-jobs-by-status-or-get-the-status-of-specific-job `__ """ # noqa: E501 request = Request(method=Method.GET, endpoint=f"/_api/job/{self._id}") response = await self._conn.send_request(request) @@ -101,7 +101,7 @@ async def result(self) -> T: is still pending. References: - - `get-the-results-of-an-async-job `__ + - `get-the-results-of-an-async-job `__ """ # noqa: E501 request = Request(method=Method.PUT, endpoint=f"/_api/job/{self._id}") response = await self._conn.send_request(request) @@ -142,7 +142,7 @@ async def cancel(self, ignore_missing: bool = False) -> bool: AsyncJobCancelError: If cancellation fails. References: - - `cancel-an-async-job `__ + - `cancel-an-async-job `__ """ # noqa: E501 request = Request(method=Method.PUT, endpoint=f"/_api/job/{self._id}/cancel") response = await self._conn.send_request(request) @@ -173,7 +173,7 @@ async def clear( AsyncJobClearError: If deletion fails. References: - - `delete-async-job-results `__ + - `delete-async-job-results `__ """ # noqa: E501 request = Request(method=Method.DELETE, endpoint=f"/_api/job/{self._id}") resp = await self._conn.send_request(request) diff --git a/arangoasync/replication.py b/arangoasync/replication.py index 436dc94..e495e89 100644 --- a/arangoasync/replication.py +++ b/arangoasync/replication.py @@ -64,7 +64,7 @@ async def inventory( ReplicationInventoryError: If retrieval fails. References: - - `get-a-replication-inventory `__ + - `get-a-replication-inventory `__ """ # noqa: E501 params: Params = dict() params["batchId"] = batch_id @@ -112,7 +112,7 @@ async def dump( ReplicationDumpError: If retrieval fails. References: - - `get-a-replication-dump `__ + - `get-a-replication-dump `__ """ # noqa: E501 params: Params = dict() params["collection"] = collection @@ -149,7 +149,7 @@ async def cluster_inventory( ReplicationClusterInventoryError: If retrieval fails. References: - - `get-the-cluster-collections-and-indexes `__ + - `get-the-cluster-collections-and-indexes `__ """ # noqa: E501 params: Params = {} if include_system is not None: @@ -179,7 +179,7 @@ async def logger_state(self) -> Result[Json]: ReplicationLoggerStateError: If retrieval fails. References: - - `get-the-replication-logger-state `__ + - `get-the-replication-logger-state `__ """ # noqa: E501 request = Request( method=Method.GET, @@ -204,7 +204,7 @@ async def applier_config(self) -> Result[Json]: ReplicationApplierConfigError: If retrieval fails. References: - - `get-the-replication-applier-configuration `__ + - `get-the-replication-applier-configuration `__ """ # noqa: E501 request = Request( method=Method.GET, @@ -229,7 +229,7 @@ async def applier_state(self) -> Result[Json]: ReplicationApplierStateError: If retrieval fails. References: - - `get-the-replication-applier-state `__ + - `get-the-replication-applier-state `__ """ # noqa: E501 request = Request( method=Method.GET, @@ -254,7 +254,7 @@ async def server_id(self) -> Result[str]: ReplicationServerIDError: If retrieval fails. References: - - `get-the-replication-server-id `__ + - `get-the-replication-server-id `__ """ # noqa: E501 request = Request( method=Method.GET, diff --git a/arangoasync/typings.py b/arangoasync/typings.py index d6adb4d..cd1c472 100644 --- a/arangoasync/typings.py +++ b/arangoasync/typings.py @@ -223,7 +223,7 @@ class KeyOptions(JsonWrapper): } References: - - `create-a-collection `__ + - `create-a-collection `__ """ # noqa: E501 def __init__( @@ -310,7 +310,7 @@ class CollectionInfo(JsonWrapper): } References: - - `get-the-collection-information `__ + - `get-the-collection-information `__ """ # noqa: E501 def __init__(self, data: Json) -> None: @@ -384,7 +384,7 @@ class UserInfo(JsonWrapper): } References: - - `create-a-user `__ + - `create-a-user `__ """ # noqa: E501 def __init__( @@ -484,7 +484,7 @@ class ServerStatusInformation(JsonWrapper): } References: - - `get-server-status-information `__ + - `get-server-status-information `__ """ # noqa: E501 def __init__(self, data: Json) -> None: @@ -543,7 +543,7 @@ class DatabaseProperties(JsonWrapper): """Properties of the database. References: - - `get-information-about-the-current-database `__ + - `get-information-about-the-current-database `__ """ # noqa: E501 def __init__(self, data: Json, strip_result: bool = False) -> None: @@ -650,7 +650,7 @@ class CollectionProperties(JsonWrapper): } References: - - `get-the-properties-of-a-collection `__ + - `get-the-properties-of-a-collection `__ """ # noqa: E501 def __init__(self, data: Json) -> None: @@ -870,7 +870,7 @@ class CollectionStatistics(JsonWrapper): } References: - - `get-the-collection-statistics `__ + - `get-the-collection-statistics `__ """ # noqa: E501 def __init__(self, data: Json) -> None: @@ -976,7 +976,7 @@ class IndexProperties(JsonWrapper): } References: - - `get-an-index `__ + - `get-an-index `__ """ # noqa: E501 def __init__(self, data: Json) -> None: @@ -1253,7 +1253,7 @@ class QueryProperties(JsonWrapper): } References: - - `create-a-cursor `__ + - `create-a-cursor `__ """ # noqa: E501 def __init__( @@ -1414,7 +1414,7 @@ class QueryExecutionPlan(JsonWrapper): """The execution plan of an AQL query. References: - - `plan `__ + - `plan `__ """ # noqa: E501 def __init__(self, data: Json) -> None: @@ -1468,7 +1468,7 @@ class QueryExecutionProfile(JsonWrapper): } References: - - `profile `__ + - `profile `__ """ # noqa: E501 def __init__(self, data: Json) -> None: @@ -1536,7 +1536,7 @@ class QueryExecutionStats(JsonWrapper): } References: - - `stats `__ + - `stats `__ """ # noqa: E501 def __init__(self, data: Json) -> None: @@ -1615,7 +1615,7 @@ class QueryExecutionExtra(JsonWrapper): """Extra information about the query result. References: - - `extra `__ + - `extra `__ """ # noqa: E501 def __init__(self, data: Json) -> None: @@ -1659,7 +1659,7 @@ class QueryTrackingConfiguration(JsonWrapper): } References: - - `get-the-aql-query-tracking-configuration `__ + - `get-the-aql-query-tracking-configuration `__ """ # noqa: E501 def __init__(self, data: Json) -> None: @@ -1718,7 +1718,7 @@ class QueryExplainOptions(JsonWrapper): } References: - - `explain-an-aql-query `__ + - `explain-an-aql-query `__ """ # noqa: E501 def __init__( @@ -1764,8 +1764,8 @@ class QueryCacheProperties(JsonWrapper): } References: - - `get-the-aql-query-results-cache-configuration `__ - - `set-the-aql-query-results-cache-configuration `__ + - `get-the-aql-query-results-cache-configuration `__ + - `set-the-aql-query-results-cache-configuration `__ """ # noqa: E501 def __init__(self, data: Json) -> None: @@ -1818,9 +1818,9 @@ class GraphProperties(JsonWrapper): } References: - - `get-a-graph `__ - - `list-all-graphs `__ - - `create-a-graph `__ + - `get-a-graph `__ + - `list-all-graphs `__ + - `create-a-graph `__ """ # noqa: E501 def __init__(self, data: Json) -> None: @@ -1927,7 +1927,7 @@ class GraphOptions(JsonWrapper): graph. References: - - `create-a-graph `__ + - `create-a-graph `__ """ # noqa: E501 def __init__( @@ -1982,7 +1982,7 @@ class VertexCollectionOptions(JsonWrapper): be a string and a valid collection name. References: - - `add-a-vertex-collection `__ + - `add-a-vertex-collection `__ """ # noqa: E501 def __init__( @@ -2009,7 +2009,7 @@ class EdgeDefinitionOptions(JsonWrapper): be a string and a valid collection name. References: - - `add-an-edge-definition `__ + - `add-an-edge-definition `__ """ # noqa: E501 def __init__( @@ -2043,7 +2043,7 @@ class AccessToken(JsonWrapper): } References: - - `create-an-access-token `__ + - `create-an-access-token `__ """ # noqa: E501 def __init__(self, data: Json) -> None: diff --git a/arangoasync/version.py b/arangoasync/version.py index 92192ee..68cdeee 100644 --- a/arangoasync/version.py +++ b/arangoasync/version.py @@ -1 +1 @@ -__version__ = "1.0.4" +__version__ = "1.0.5" diff --git a/docs/certificates.rst b/docs/certificates.rst index c0ba7af..f8fa1e5 100644 --- a/docs/certificates.rst +++ b/docs/certificates.rst @@ -129,4 +129,4 @@ See the `ArangoDB Manual`_ for more information on security features. # Reload TLS data tls = await db.reload_tls() -.. _ArangoDB Manual: https://docs.arango.ai/stable/develop/http-api/security/ +.. _ArangoDB Manual: https://docs.arango.ai/arangodb/arangodb/stable/develop/http-api/security/ diff --git a/docs/overview.rst b/docs/overview.rst index 77c0fc7..38ecfd7 100644 --- a/docs/overview.rst +++ b/docs/overview.rst @@ -64,7 +64,7 @@ You may also use the client without a context manager, but you must ensure to cl Another example with `graphs`_: -.. _graphs: https://docs.arango.ai/stable/graphs/ +.. _graphs: https://docs.arango.ai/arangodb/stable/graphs/ .. code-block:: python diff --git a/docs/view.rst b/docs/view.rst index 3a1ef06..5ab61e9 100644 --- a/docs/view.rst +++ b/docs/view.rst @@ -63,7 +63,7 @@ management, refer to `ArangoDB Manual`_. For more information on the content of view **properties**, see `Search Alias Views`_ and `Arangosearch Views`_. -.. _Search Alias Views: https://docs.arango.ai/stable/develop/http-api/views/search-alias-views/ -.. _Arangosearch Views: https://docs.arango.ai/stable/develop/http-api/views/arangosearch-views/ +.. _Search Alias Views: https://docs.arango.ai/arangodb/stable/develop/http-api/views/search-alias-views/ +.. _Arangosearch Views: https://docs.arango.ai/arangodb/stable/develop/http-api/views/arangosearch-views/ Refer to :class:`arangoasync.database.StandardDatabase` class for API specification.