Skip to content

docs: Add documentation for ArangoDB integration#11597

Merged
bogdankostic merged 2 commits into
mainfrom
arangodb_docs
Jun 16, 2026
Merged

docs: Add documentation for ArangoDB integration#11597
bogdankostic merged 2 commits into
mainfrom
arangodb_docs

Conversation

@bogdankostic

Copy link
Copy Markdown
Contributor

Related Issues

Proposed Changes:

This PR adds documentation for the ArangoDB integration added in deepset-ai/haystack-core-integrations#3340.

How did you test it?

Notes for the reviewer

Checklist

  • I have read the contributors guidelines and the code of conduct.
  • I have updated the related issue with new insights and changes.
  • I have added unit tests and updated the docstrings.
  • I've used one of the conventional commit types for my PR title: fix:, feat:, build:, chore:, ci:, docs:, style:, refactor:, perf:, test: and added ! in case the PR includes breaking changes.
  • I have documented my code.
  • I have added a release note file, following the contributors guidelines.
  • I have run pre-commit hooks and fixed any issue.

@bogdankostic bogdankostic requested a review from a team as a code owner June 12, 2026 08:39
@bogdankostic bogdankostic requested review from julian-risch and removed request for a team June 12, 2026 08:39
@vercel

vercel Bot commented Jun 12, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
haystack-docs Ready Ready Preview, Comment Jun 16, 2026 9:38am

Request Review

@julian-risch julian-risch left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are some naming issues with the name of the DocumentStore. We refer almost everywhere to ArangoDB but the classes are named ArangoDocumentStore and ArangoEmbeddingRetriever unfortunately.

description: "Use the ArangoDB multi-model database with Haystack for embedding retrieval and GraphRAG workloads."
---

# ArangoDBDocumentStore

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

class name is ArangoDocumentStore (without DB)

Comment on lines +2 to +4
title: "ArangoDBDocumentStore"
id: arangodbdocumentstore
slug: "/arangodbdocumentstore"

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

class is named ArangoDocumentStore

| | |
| --- | --- |
| **Most common position in a pipeline** | 1. After a Text Embedder and before a [`PromptBuilder`](../builders/promptbuilder.mdx) in a RAG pipeline <br /><br /> 2. The last component in a semantic search pipeline |
| **Mandatory init variables** | `document_store`: An instance of an [ArangoDBDocumentStore](../../document-stores/arangodbdocumentstore.mdx) |

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

class name is ArangoDocumentStore

@claude

claude Bot commented Jun 16, 2026

Copy link
Copy Markdown

Code review

No issues found. Checked for bugs and CLAUDE.md compliance.

@bogdankostic bogdankostic merged commit 394a152 into main Jun 16, 2026
22 checks passed
@bogdankostic bogdankostic deleted the arangodb_docs branch June 16, 2026 09:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants