Skip to content

Commit b88493a

Browse files
Sync Core Integrations API reference (mongodb_atlas) on Docusaurus (#10025)
Co-authored-by: mpangrazzi <[email protected]>
1 parent 89f4208 commit b88493a

File tree

4 files changed

+316
-0
lines changed

4 files changed

+316
-0
lines changed

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

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -287,6 +287,85 @@ 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_by_filter"></a>
291+
292+
#### MongoDBAtlasDocumentStore.delete\_by\_filter
293+
294+
```python
295+
def delete_by_filter(filters: Dict[str, Any]) -> int
296+
```
297+
298+
Deletes all documents that match the provided filters.
299+
300+
**Arguments**:
301+
302+
- `filters`: The filters to apply to select documents for deletion.
303+
For filter syntax, see [Haystack metadata filtering](https://docs.haystack.deepset.ai/docs/metadata-filtering)
304+
305+
**Returns**:
306+
307+
The number of documents deleted.
308+
309+
<a id="haystack_integrations.document_stores.mongodb_atlas.document_store.MongoDBAtlasDocumentStore.delete_by_filter_async"></a>
310+
311+
#### MongoDBAtlasDocumentStore.delete\_by\_filter\_async
312+
313+
```python
314+
async def delete_by_filter_async(filters: Dict[str, Any]) -> int
315+
```
316+
317+
Asynchronously deletes all documents that match the provided filters.
318+
319+
**Arguments**:
320+
321+
- `filters`: The filters to apply to select documents for deletion.
322+
For filter syntax, see [Haystack metadata filtering](https://docs.haystack.deepset.ai/docs/metadata-filtering)
323+
324+
**Returns**:
325+
326+
The number of documents deleted.
327+
328+
<a id="haystack_integrations.document_stores.mongodb_atlas.document_store.MongoDBAtlasDocumentStore.update_by_filter"></a>
329+
330+
#### MongoDBAtlasDocumentStore.update\_by\_filter
331+
332+
```python
333+
def update_by_filter(filters: Dict[str, Any], meta: Dict[str, Any]) -> int
334+
```
335+
336+
Updates the metadata of all documents that match the provided filters.
337+
338+
**Arguments**:
339+
340+
- `filters`: The filters to apply to select documents for updating.
341+
For filter syntax, see [Haystack metadata filtering](https://docs.haystack.deepset.ai/docs/metadata-filtering)
342+
- `meta`: The metadata fields to update.
343+
344+
**Returns**:
345+
346+
The number of documents updated.
347+
348+
<a id="haystack_integrations.document_stores.mongodb_atlas.document_store.MongoDBAtlasDocumentStore.update_by_filter_async"></a>
349+
350+
#### MongoDBAtlasDocumentStore.update\_by\_filter\_async
351+
352+
```python
353+
async def update_by_filter_async(filters: Dict[str, Any],
354+
meta: Dict[str, Any]) -> int
355+
```
356+
357+
Asynchronously updates the metadata of all documents that match the provided filters.
358+
359+
**Arguments**:
360+
361+
- `filters`: The filters to apply to select documents for updating.
362+
For filter syntax, see [Haystack metadata filtering](https://docs.haystack.deepset.ai/docs/metadata-filtering)
363+
- `meta`: The metadata fields to update.
364+
365+
**Returns**:
366+
367+
The number of documents updated.
368+
290369
<a id="haystack_integrations.document_stores.mongodb_atlas.document_store.MongoDBAtlasDocumentStore.delete_all_documents"></a>
291370

292371
#### MongoDBAtlasDocumentStore.delete\_all\_documents

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

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -287,6 +287,85 @@ 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_by_filter"></a>
291+
292+
#### MongoDBAtlasDocumentStore.delete\_by\_filter
293+
294+
```python
295+
def delete_by_filter(filters: Dict[str, Any]) -> int
296+
```
297+
298+
Deletes all documents that match the provided filters.
299+
300+
**Arguments**:
301+
302+
- `filters`: The filters to apply to select documents for deletion.
303+
For filter syntax, see [Haystack metadata filtering](https://docs.haystack.deepset.ai/docs/metadata-filtering)
304+
305+
**Returns**:
306+
307+
The number of documents deleted.
308+
309+
<a id="haystack_integrations.document_stores.mongodb_atlas.document_store.MongoDBAtlasDocumentStore.delete_by_filter_async"></a>
310+
311+
#### MongoDBAtlasDocumentStore.delete\_by\_filter\_async
312+
313+
```python
314+
async def delete_by_filter_async(filters: Dict[str, Any]) -> int
315+
```
316+
317+
Asynchronously deletes all documents that match the provided filters.
318+
319+
**Arguments**:
320+
321+
- `filters`: The filters to apply to select documents for deletion.
322+
For filter syntax, see [Haystack metadata filtering](https://docs.haystack.deepset.ai/docs/metadata-filtering)
323+
324+
**Returns**:
325+
326+
The number of documents deleted.
327+
328+
<a id="haystack_integrations.document_stores.mongodb_atlas.document_store.MongoDBAtlasDocumentStore.update_by_filter"></a>
329+
330+
#### MongoDBAtlasDocumentStore.update\_by\_filter
331+
332+
```python
333+
def update_by_filter(filters: Dict[str, Any], meta: Dict[str, Any]) -> int
334+
```
335+
336+
Updates the metadata of all documents that match the provided filters.
337+
338+
**Arguments**:
339+
340+
- `filters`: The filters to apply to select documents for updating.
341+
For filter syntax, see [Haystack metadata filtering](https://docs.haystack.deepset.ai/docs/metadata-filtering)
342+
- `meta`: The metadata fields to update.
343+
344+
**Returns**:
345+
346+
The number of documents updated.
347+
348+
<a id="haystack_integrations.document_stores.mongodb_atlas.document_store.MongoDBAtlasDocumentStore.update_by_filter_async"></a>
349+
350+
#### MongoDBAtlasDocumentStore.update\_by\_filter\_async
351+
352+
```python
353+
async def update_by_filter_async(filters: Dict[str, Any],
354+
meta: Dict[str, Any]) -> int
355+
```
356+
357+
Asynchronously updates the metadata of all documents that match the provided filters.
358+
359+
**Arguments**:
360+
361+
- `filters`: The filters to apply to select documents for updating.
362+
For filter syntax, see [Haystack metadata filtering](https://docs.haystack.deepset.ai/docs/metadata-filtering)
363+
- `meta`: The metadata fields to update.
364+
365+
**Returns**:
366+
367+
The number of documents updated.
368+
290369
<a id="haystack_integrations.document_stores.mongodb_atlas.document_store.MongoDBAtlasDocumentStore.delete_all_documents"></a>
291370

292371
#### MongoDBAtlasDocumentStore.delete\_all\_documents

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

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -287,6 +287,85 @@ 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_by_filter"></a>
291+
292+
#### MongoDBAtlasDocumentStore.delete\_by\_filter
293+
294+
```python
295+
def delete_by_filter(filters: Dict[str, Any]) -> int
296+
```
297+
298+
Deletes all documents that match the provided filters.
299+
300+
**Arguments**:
301+
302+
- `filters`: The filters to apply to select documents for deletion.
303+
For filter syntax, see [Haystack metadata filtering](https://docs.haystack.deepset.ai/docs/metadata-filtering)
304+
305+
**Returns**:
306+
307+
The number of documents deleted.
308+
309+
<a id="haystack_integrations.document_stores.mongodb_atlas.document_store.MongoDBAtlasDocumentStore.delete_by_filter_async"></a>
310+
311+
#### MongoDBAtlasDocumentStore.delete\_by\_filter\_async
312+
313+
```python
314+
async def delete_by_filter_async(filters: Dict[str, Any]) -> int
315+
```
316+
317+
Asynchronously deletes all documents that match the provided filters.
318+
319+
**Arguments**:
320+
321+
- `filters`: The filters to apply to select documents for deletion.
322+
For filter syntax, see [Haystack metadata filtering](https://docs.haystack.deepset.ai/docs/metadata-filtering)
323+
324+
**Returns**:
325+
326+
The number of documents deleted.
327+
328+
<a id="haystack_integrations.document_stores.mongodb_atlas.document_store.MongoDBAtlasDocumentStore.update_by_filter"></a>
329+
330+
#### MongoDBAtlasDocumentStore.update\_by\_filter
331+
332+
```python
333+
def update_by_filter(filters: Dict[str, Any], meta: Dict[str, Any]) -> int
334+
```
335+
336+
Updates the metadata of all documents that match the provided filters.
337+
338+
**Arguments**:
339+
340+
- `filters`: The filters to apply to select documents for updating.
341+
For filter syntax, see [Haystack metadata filtering](https://docs.haystack.deepset.ai/docs/metadata-filtering)
342+
- `meta`: The metadata fields to update.
343+
344+
**Returns**:
345+
346+
The number of documents updated.
347+
348+
<a id="haystack_integrations.document_stores.mongodb_atlas.document_store.MongoDBAtlasDocumentStore.update_by_filter_async"></a>
349+
350+
#### MongoDBAtlasDocumentStore.update\_by\_filter\_async
351+
352+
```python
353+
async def update_by_filter_async(filters: Dict[str, Any],
354+
meta: Dict[str, Any]) -> int
355+
```
356+
357+
Asynchronously updates the metadata of all documents that match the provided filters.
358+
359+
**Arguments**:
360+
361+
- `filters`: The filters to apply to select documents for updating.
362+
For filter syntax, see [Haystack metadata filtering](https://docs.haystack.deepset.ai/docs/metadata-filtering)
363+
- `meta`: The metadata fields to update.
364+
365+
**Returns**:
366+
367+
The number of documents updated.
368+
290369
<a id="haystack_integrations.document_stores.mongodb_atlas.document_store.MongoDBAtlasDocumentStore.delete_all_documents"></a>
291370

292371
#### MongoDBAtlasDocumentStore.delete\_all\_documents

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

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -287,6 +287,85 @@ 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_by_filter"></a>
291+
292+
#### MongoDBAtlasDocumentStore.delete\_by\_filter
293+
294+
```python
295+
def delete_by_filter(filters: Dict[str, Any]) -> int
296+
```
297+
298+
Deletes all documents that match the provided filters.
299+
300+
**Arguments**:
301+
302+
- `filters`: The filters to apply to select documents for deletion.
303+
For filter syntax, see [Haystack metadata filtering](https://docs.haystack.deepset.ai/docs/metadata-filtering)
304+
305+
**Returns**:
306+
307+
The number of documents deleted.
308+
309+
<a id="haystack_integrations.document_stores.mongodb_atlas.document_store.MongoDBAtlasDocumentStore.delete_by_filter_async"></a>
310+
311+
#### MongoDBAtlasDocumentStore.delete\_by\_filter\_async
312+
313+
```python
314+
async def delete_by_filter_async(filters: Dict[str, Any]) -> int
315+
```
316+
317+
Asynchronously deletes all documents that match the provided filters.
318+
319+
**Arguments**:
320+
321+
- `filters`: The filters to apply to select documents for deletion.
322+
For filter syntax, see [Haystack metadata filtering](https://docs.haystack.deepset.ai/docs/metadata-filtering)
323+
324+
**Returns**:
325+
326+
The number of documents deleted.
327+
328+
<a id="haystack_integrations.document_stores.mongodb_atlas.document_store.MongoDBAtlasDocumentStore.update_by_filter"></a>
329+
330+
#### MongoDBAtlasDocumentStore.update\_by\_filter
331+
332+
```python
333+
def update_by_filter(filters: Dict[str, Any], meta: Dict[str, Any]) -> int
334+
```
335+
336+
Updates the metadata of all documents that match the provided filters.
337+
338+
**Arguments**:
339+
340+
- `filters`: The filters to apply to select documents for updating.
341+
For filter syntax, see [Haystack metadata filtering](https://docs.haystack.deepset.ai/docs/metadata-filtering)
342+
- `meta`: The metadata fields to update.
343+
344+
**Returns**:
345+
346+
The number of documents updated.
347+
348+
<a id="haystack_integrations.document_stores.mongodb_atlas.document_store.MongoDBAtlasDocumentStore.update_by_filter_async"></a>
349+
350+
#### MongoDBAtlasDocumentStore.update\_by\_filter\_async
351+
352+
```python
353+
async def update_by_filter_async(filters: Dict[str, Any],
354+
meta: Dict[str, Any]) -> int
355+
```
356+
357+
Asynchronously updates the metadata of all documents that match the provided filters.
358+
359+
**Arguments**:
360+
361+
- `filters`: The filters to apply to select documents for updating.
362+
For filter syntax, see [Haystack metadata filtering](https://docs.haystack.deepset.ai/docs/metadata-filtering)
363+
- `meta`: The metadata fields to update.
364+
365+
**Returns**:
366+
367+
The number of documents updated.
368+
290369
<a id="haystack_integrations.document_stores.mongodb_atlas.document_store.MongoDBAtlasDocumentStore.delete_all_documents"></a>
291370

292371
#### MongoDBAtlasDocumentStore.delete\_all\_documents

0 commit comments

Comments
 (0)