Skip to content

Package Overview

ArcadeDB Python provides a self-contained embedded package that runs the database directly in your Python process with a bundled JRE - no Java installation required!

The Package

Package Wheel Size Installed Size Java Required Studio UI Query Languages
arcadedb-embedded ~74MB ~101-103MB ❌ No ✅ SQL, OpenCypher, MongoDB

Installation:

uv pip install arcadedb-embedded

Requirements: Python 3.10–3.14 (packaged; primary testing on 3.12) - No Java installation needed!

What's Inside

The package includes everything you need:

  • ArcadeDB JARs (~38MB, uncompressed): Core database with all features
  • Bundled JRE (~63MB, uncompressed): Platform-specific Java 25 runtime (via jlink)

Current Linux x86_64 package info: ~74MB compressed wheel, ~63MB JRE, ~38MB JARs, and ~101MB installed. Local installs may show closer to ~103MB on disk depending on filesystem allocation.

These numbers are measured from the built wheel file and the extracted site-packages/arcadedb_embedded/ directory, and they vary by platform and version.

Platform Support

Pre-built platform-specific wheels are available for 4 platforms. Sizes stay in the same ballpark across platforms, but vary slightly by platform and version (see size breakdown below).

Key Features:

  • ✅ All platforms use platform-specific wheels (not universal)
  • ✅ uv pip automatically selects the correct wheel for your system
  • ✅ Each platform has its own bundled JRE optimized for that architecture
  • ✅ Current suite validated in the latest local run: 331 passed
  • ✅ Built on native runners (no emulation) for optimal performance

What's Included

Core Features:

  • ✅ No Java Installation Required: Platform-specific JRE bundled (~63MB uncompressed)
  • ✅ Core Database: All models (Graph, Document, Key/Value, Vector, Time Series)
  • ✅ Query Languages: SQL, OpenCypher, MongoDB (all included)
  • ✅ Studio Web UI: Visual database explorer and query editor
  • ✅ Wire Protocols: HTTP REST, PostgreSQL, MongoDB, Redis
  • ✅ Vector Search: Graph-based indexing for embeddings
  • ✅ Data Import: CSV, XML, and ArcadeDB JSONL import

Optimized:

  • Some components are excluded to optimize package size (e.g., gRPC wire protocol)
  • See scripts/jar_exclusions.txt in the repository for details

Test Results

The current bindings suite reports 331 passed in a full local run:

  • ✅ All core database operations
  • ✅ SQL and OpenCypher queries
  • ✅ HTTP server and Studio UI
  • ✅ Vector search and import operations
  • ✅ All platforms validated

Use Cases

Perfect for:

  • Production Python applications
  • Development and debugging (with Studio UI)
  • Cloud deployments (no Java setup needed!)
  • Docker containers
  • Desktop applications
  • Multi-model database needs (Graph, Document, Vector, Time Series)
  • Any scenario requiring SQL or OpenCypher queries

Accessing Studio UI

from arcadedb_embedded import create_server

# Start HTTP server with Studio UI
server = create_server("./databases")
server.start()

# Studio UI available at: http://localhost:2480
# Create databases, run queries, visualize data

# When done
server.stop()

Studio in Browser

Once the server starts, open your browser to http://localhost:2480 to access the Studio UI.

Import Statement

The import is always:

import arcadedb_embedded as arcadedb

Simple and consistent across all platforms!

Size Breakdown

Current sizes are ballpark values and can move with ArcadeDB, the bundled JRE, the target platform, and filesystem overhead after installation:

  • Wheel (compressed): ~74MB
  • Installed package: ~101-103MB

Components (uncompressed):

  • ArcadeDB JARs: ~38MB
  • Bundled JRE: ~63MB (platform-specific Java 25 runtime via jlink)

Optimizations:

  • Some components excluded for size (e.g., gRPC wire protocol)
  • See scripts/jar_exclusions.txt in repository for details

Installation Tips

Check Installed Package

import arcadedb_embedded as arcadedb
print(f"Version: {arcadedb.__version__}")

# Verify database works
with arcadedb.create_database("./test") as db:
    result = db.query("sql", "SELECT 1 as test")
    print(f"Database working: {result.first().get('test') == 1}")

Platform Detection

uv pip automatically selects the correct platform-specific wheel:

# On Linux x64 for Python 3.12, installs: arcadedb_embedded-X.Y.Z-cp312-cp312-manylinux_2_34_x86_64.whl
# On macOS ARM64 for Python 3.12, installs: arcadedb_embedded-X.Y.Z-cp312-cp312-macosx_11_0_arm64.whl
# On Windows x86_64 for Python 3.12, installs: arcadedb_embedded-X.Y.Z-cp312-cp312-win_amd64.whl
# etc.

You can verify which platform you're on:

import platform
print(f"System: {platform.system()}")
print(f"Machine: {platform.machine()}")
print(f"Python: {platform.python_version()}")

Next Steps