Skip to main content
Version: v25.1 (latest)

Python

PyPI

The official Dgraph Python client communicates with the server using gRPC.

Installation​

pip install pydgraph

Supported Versions​

Dgraph versionpydgraph version
dgraph 21.03.Xpydgraph 21.03.X
dgraph 23.0.Xpydgraph 23.0.X
dgraph 24.X.Ypydgraph 24.X.Y
dgraph 25.X.Ypydgraph 25.X.Y

Quick Start​

Using Connection Strings (v25+)​

The simplest way to connect is using a connection string:

import pydgraph

client = pydgraph.open("dgraph://localhost:9080")

With ACL authentication:

client = pydgraph.open("dgraph://groot:password@localhost:9080")

Running Queries and Mutations​

import pydgraph
import json

# Create client
client = pydgraph.open("dgraph://localhost:9080")

# Set schema
op = pydgraph.Operation(schema='name: string @index(exact) .')
client.alter(op)

# Run a mutation
txn = client.txn()
try:
    txn.mutate(set_obj={'name': 'Alice'}, commit_now=True)
finally:
    txn.discard()

# Run a query
query = '{ alice(func: eq(name, "Alice")) { name } }'
res = client.txn(read_only=True).query(query)
print(json.loads(res.json))

# Clean up
client.close()

Multi-tenancy​

In multi-tenant environments, use login_into_namespace() to authenticate to a specific namespace:

client_stub = pydgraph.DgraphClientStub('localhost:9080')
client = pydgraph.DgraphClient(client_stub)

# Login to namespace 123
client.login_into_namespace("groot", "password", "123")

Once logged in, the client can perform all operations allowed for that user in the specified namespace.

Documentation​

For complete API documentation, examples, and advanced usage:

The GitHub README covers:

  • Connection strings and client creation
  • Transactions (read-only, best-effort)
  • Mutations (JSON and RDF formats)
  • Queries with variables
  • Upserts and conditional upserts
  • Async/await support
  • TLS configuration
  • And more