Skip to content

Commit deb5a95

Browse files
Sync Core Integrations API reference (mongodb_atlas) on Docusaurus (#9963)
Co-authored-by: davidsbatista <7937824+davidsbatista@users.noreply.github.com>
1 parent b783027 commit deb5a95

File tree

4 files changed

+140
-0
lines changed

4 files changed

+140
-0
lines changed

docs-website/reference/integrations-api/mongodb_atlas.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -287,6 +287,40 @@ Asynchronously deletes all documents with a matching document_ids from the docum
287287

288288
- `document_ids`: the document ids to delete
289289

290+
<a id="haystack_integrations.document_stores.mongodb_atlas.document_store.MongoDBAtlasDocumentStore.delete_all_documents"></a>
291+
292+
#### MongoDBAtlasDocumentStore.delete\_all\_documents
293+
294+
```python
295+
def delete_all_documents(*, recreate_collection: bool = False) -> None
296+
```
297+
298+
Deletes all documents in the document store.
299+
300+
**Arguments**:
301+
302+
- `recreate_collection`: If True, the collection will be dropped and recreated with the original
303+
configuration and indexes. If False, all documents will be deleted while preserving the collection.
304+
Recreating the collection is faster for very large collections.
305+
306+
<a id="haystack_integrations.document_stores.mongodb_atlas.document_store.MongoDBAtlasDocumentStore.delete_all_documents_async"></a>
307+
308+
#### MongoDBAtlasDocumentStore.delete\_all\_documents\_async
309+
310+
```python
311+
async def delete_all_documents_async(*,
312+
recreate_collection: bool = False
313+
) -> None
314+
```
315+
316+
Asynchronously deletes all documents in the document store.
317+
318+
**Arguments**:
319+
320+
- `recreate_collection`: If True, the collection will be dropped and recreated with the original
321+
configuration and indexes. If False, all documents will be deleted while preserving the collection.
322+
Recreating the collection is faster for very large collections.
323+
290324
<a id="haystack_integrations.components.retrievers.mongodb_atlas.embedding_retriever"></a>
291325

292326
## Module haystack\_integrations.components.retrievers.mongodb\_atlas.embedding\_retriever
@@ -609,3 +643,4 @@ details.
609643

610644
A dictionary with the following keys:
611645
- `documents`: List of Documents most similar to the given `query`
646+

docs-website/reference_versioned_docs/version-2.17/integrations-api/mongodb_atlas.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -287,6 +287,40 @@ Asynchronously deletes all documents with a matching document_ids from the docum
287287

288288
- `document_ids`: the document ids to delete
289289

290+
<a id="haystack_integrations.document_stores.mongodb_atlas.document_store.MongoDBAtlasDocumentStore.delete_all_documents"></a>
291+
292+
#### MongoDBAtlasDocumentStore.delete\_all\_documents
293+
294+
```python
295+
def delete_all_documents(*, recreate_collection: bool = False) -> None
296+
```
297+
298+
Deletes all documents in the document store.
299+
300+
**Arguments**:
301+
302+
- `recreate_collection`: If True, the collection will be dropped and recreated with the original
303+
configuration and indexes. If False, all documents will be deleted while preserving the collection.
304+
Recreating the collection is faster for very large collections.
305+
306+
<a id="haystack_integrations.document_stores.mongodb_atlas.document_store.MongoDBAtlasDocumentStore.delete_all_documents_async"></a>
307+
308+
#### MongoDBAtlasDocumentStore.delete\_all\_documents\_async
309+
310+
```python
311+
async def delete_all_documents_async(*,
312+
recreate_collection: bool = False
313+
) -> None
314+
```
315+
316+
Asynchronously deletes all documents in the document store.
317+
318+
**Arguments**:
319+
320+
- `recreate_collection`: If True, the collection will be dropped and recreated with the original
321+
configuration and indexes. If False, all documents will be deleted while preserving the collection.
322+
Recreating the collection is faster for very large collections.
323+
290324
<a id="haystack_integrations.components.retrievers.mongodb_atlas.embedding_retriever"></a>
291325

292326
## Module haystack\_integrations.components.retrievers.mongodb\_atlas.embedding\_retriever
@@ -609,3 +643,4 @@ details.
609643

610644
A dictionary with the following keys:
611645
- `documents`: List of Documents most similar to the given `query`
646+

docs-website/reference_versioned_docs/version-2.18/integrations-api/mongodb_atlas.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -287,6 +287,40 @@ Asynchronously deletes all documents with a matching document_ids from the docum
287287

288288
- `document_ids`: the document ids to delete
289289

290+
<a id="haystack_integrations.document_stores.mongodb_atlas.document_store.MongoDBAtlasDocumentStore.delete_all_documents"></a>
291+
292+
#### MongoDBAtlasDocumentStore.delete\_all\_documents
293+
294+
```python
295+
def delete_all_documents(*, recreate_collection: bool = False) -> None
296+
```
297+
298+
Deletes all documents in the document store.
299+
300+
**Arguments**:
301+
302+
- `recreate_collection`: If True, the collection will be dropped and recreated with the original
303+
configuration and indexes. If False, all documents will be deleted while preserving the collection.
304+
Recreating the collection is faster for very large collections.
305+
306+
<a id="haystack_integrations.document_stores.mongodb_atlas.document_store.MongoDBAtlasDocumentStore.delete_all_documents_async"></a>
307+
308+
#### MongoDBAtlasDocumentStore.delete\_all\_documents\_async
309+
310+
```python
311+
async def delete_all_documents_async(*,
312+
recreate_collection: bool = False
313+
) -> None
314+
```
315+
316+
Asynchronously deletes all documents in the document store.
317+
318+
**Arguments**:
319+
320+
- `recreate_collection`: If True, the collection will be dropped and recreated with the original
321+
configuration and indexes. If False, all documents will be deleted while preserving the collection.
322+
Recreating the collection is faster for very large collections.
323+
290324
<a id="haystack_integrations.components.retrievers.mongodb_atlas.embedding_retriever"></a>
291325

292326
## Module haystack\_integrations.components.retrievers.mongodb\_atlas.embedding\_retriever
@@ -609,3 +643,4 @@ details.
609643

610644
A dictionary with the following keys:
611645
- `documents`: List of Documents most similar to the given `query`
646+

docs-website/reference_versioned_docs/version-2.19/integrations-api/mongodb_atlas.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -287,6 +287,40 @@ Asynchronously deletes all documents with a matching document_ids from the docum
287287

288288
- `document_ids`: the document ids to delete
289289

290+
<a id="haystack_integrations.document_stores.mongodb_atlas.document_store.MongoDBAtlasDocumentStore.delete_all_documents"></a>
291+
292+
#### MongoDBAtlasDocumentStore.delete\_all\_documents
293+
294+
```python
295+
def delete_all_documents(*, recreate_collection: bool = False) -> None
296+
```
297+
298+
Deletes all documents in the document store.
299+
300+
**Arguments**:
301+
302+
- `recreate_collection`: If True, the collection will be dropped and recreated with the original
303+
configuration and indexes. If False, all documents will be deleted while preserving the collection.
304+
Recreating the collection is faster for very large collections.
305+
306+
<a id="haystack_integrations.document_stores.mongodb_atlas.document_store.MongoDBAtlasDocumentStore.delete_all_documents_async"></a>
307+
308+
#### MongoDBAtlasDocumentStore.delete\_all\_documents\_async
309+
310+
```python
311+
async def delete_all_documents_async(*,
312+
recreate_collection: bool = False
313+
) -> None
314+
```
315+
316+
Asynchronously deletes all documents in the document store.
317+
318+
**Arguments**:
319+
320+
- `recreate_collection`: If True, the collection will be dropped and recreated with the original
321+
configuration and indexes. If False, all documents will be deleted while preserving the collection.
322+
Recreating the collection is faster for very large collections.
323+
290324
<a id="haystack_integrations.components.retrievers.mongodb_atlas.embedding_retriever"></a>
291325

292326
## Module haystack\_integrations.components.retrievers.mongodb\_atlas.embedding\_retriever
@@ -609,3 +643,4 @@ details.
609643

610644
A dictionary with the following keys:
611645
- `documents`: List of Documents most similar to the given `query`
646+

0 commit comments

Comments
 (0)