Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/arangodb/python-arango
The official ArangoDB Python driver.
https://github.com/arangodb/python-arango
arangodb arangodb-client arangodb-driver python
Last synced: 2 days ago
JSON representation
The official ArangoDB Python driver.
- Host: GitHub
- URL: https://github.com/arangodb/python-arango
- Owner: arangodb
- License: mit
- Created: 2014-05-20T09:28:59.000Z (over 10 years ago)
- Default Branch: main
- Last Pushed: 2024-11-28T19:31:54.000Z (15 days ago)
- Last Synced: 2024-12-04T19:56:06.714Z (9 days ago)
- Topics: arangodb, arangodb-client, arangodb-driver, python
- Language: Python
- Homepage: https://docs.python-arango.com
- Size: 1.44 MB
- Stars: 448
- Watchers: 11
- Forks: 75
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-arangodb - python-arango
README
[](https://dl.circleci.com/status-badge/redirect/gh/arangodb/python-arango/tree/main)
[](https://github.com/arangodb/python-arango/actions/workflows/codeql.yaml)
[](https://github.com/arangodb/python-arango/actions/workflows/docs.yaml)
[](https://codecov.io/gh/arangodb/python-arango)
[](https://github.com/arangodb/python-arango/commits/main)
[](https://pypi.org/project/python-arango/)
[](https://pypi.org/project/python-arango/)
[](https://github.com/arangodb/python-arango/blob/main/LICENSE)
[](https://github.com/psf/black)
[](https://pepy.tech/project/python-arango)
# Python-Arango
Python driver for [ArangoDB](https://www.arangodb.com), a scalable multi-model
database natively supporting documents, graphs and search.
## Requirements
- ArangoDB version 3.11+
- Python version 3.8+
## Installation
```shell
pip install python-arango --upgrade
```
## Getting Started
Here is a simple usage example:
```python
from arango import ArangoClient
# Initialize the client for ArangoDB.
client = ArangoClient(hosts="http://localhost:8529")
# Connect to "_system" database as root user.
sys_db = client.db("_system", username="root", password="passwd")
# Create a new database named "test".
sys_db.create_database("test")
# Connect to "test" database as root user.
db = client.db("test", username="root", password="passwd")
# Create a new collection named "students".
students = db.create_collection("students")
# Add a persistent index to the collection.
students.add_index({'type': 'persistent', 'fields': ['name'], 'unique': True})
# Insert new documents into the collection.
students.insert({"name": "jane", "age": 39})
students.insert({"name": "josh", "age": 18})
students.insert({"name": "judy", "age": 21})
# Execute an AQL query and iterate through the result cursor.
cursor = db.aql.execute("FOR doc IN students RETURN doc")
student_names = [document["name"] for document in cursor]
```
Another example with [graphs](https://www.arangodb.com/docs/stable/graphs.html):
```python
from arango import ArangoClient
# Initialize the client for ArangoDB.
client = ArangoClient(hosts="http://localhost:8529")
# Connect to "test" database as root user.
db = client.db("test", username="root", password="passwd")
# Create a new graph named "school".
graph = db.create_graph("school")
# Create a new EnterpriseGraph [Enterprise Edition]
eegraph = db.create_graph(
name="school",
smart=True)
# Create vertex collections for the graph.
students = graph.create_vertex_collection("students")
lectures = graph.create_vertex_collection("lectures")
# Create an edge definition (relation) for the graph.
edges = graph.create_edge_definition(
edge_collection="register",
from_vertex_collections=["students"],
to_vertex_collections=["lectures"]
)
# Insert vertex documents into "students" (from) vertex collection.
students.insert({"_key": "01", "full_name": "Anna Smith"})
students.insert({"_key": "02", "full_name": "Jake Clark"})
students.insert({"_key": "03", "full_name": "Lisa Jones"})
# Insert vertex documents into "lectures" (to) vertex collection.
lectures.insert({"_key": "MAT101", "title": "Calculus"})
lectures.insert({"_key": "STA101", "title": "Statistics"})
lectures.insert({"_key": "CSC101", "title": "Algorithms"})
# Insert edge documents into "register" edge collection.
edges.insert({"_from": "students/01", "_to": "lectures/MAT101"})
edges.insert({"_from": "students/01", "_to": "lectures/STA101"})
edges.insert({"_from": "students/01", "_to": "lectures/CSC101"})
edges.insert({"_from": "students/02", "_to": "lectures/MAT101"})
edges.insert({"_from": "students/02", "_to": "lectures/STA101"})
edges.insert({"_from": "students/03", "_to": "lectures/CSC101"})
# Traverse the graph in outbound direction, breath-first.
query = """
FOR v, e, p IN 1..3 OUTBOUND 'students/01' GRAPH 'school'
OPTIONS { bfs: true, uniqueVertices: 'global' }
RETURN {vertex: v, edge: e, path: p}
"""
cursor = db.aql.execute(query)
```
Please see the [documentation](https://docs.python-arango.com) for more details.