ArangoDB
ArangoDB Logo
    • About ArangoDB
      • Use Cases
      • Features
        • Community Edition
        • Enterprise Edition
        • Highlights by Version
    • Get Started
      • Set up a cloud instance
      • On-premises installation
      • Start using AQL
      • How to Interact with ArangoDB
    • Concepts
      • Data Structure
        • Databases
        • Collections
        • Documents
          • Schema Validation
          • Computed Values
        • Views
      • Data Models
      • Data Retrieval
    • ArangoGraph
      • Organizations
        • Users & Groups
        • Billing
        • Credits & Usage
      • Projects
      • Deployments
        • Private endpoints
        • Upgrades and Versioning
      • Data Loader
        • Add files
        • Design graph
        • Start import
        • Example
      • Notebooks
      • My Account
      • Monitoring & Metrics
      • Security and Access Control
        • X.509 Certificates
        • Single Sign-On
          • SCIM Provisioning
      • Backups
      • ArangoGraph API
        • Get started with the API
        • Get started with Oasisctl
      • Oasisctl
        • Options
        • Accept
          • Accept Organization
          • Accept Organization Invite
        • Add
          • Add Audit Log
          • Add Audit Log Destination
          • Add Group
          • Add Group Members
        • Audit Log
          • Audit Log Attach
          • Audit Log Detach
          • Audit Log Get
          • Audit Log Get Attached
          • Audit Log Get Attached Project
        • Backup
          • Backup Copy
          • Backup Download
        • Clone
          • Clone Deployment
          • Clone Deployment Backup
        • Completion
        • Create
          • Create API Key
          • Create Audit Log
          • Create Backup
          • Create Backup Policy
          • Create CA Certificate
          • Create Deployment
          • Create Example
          • Create Example Installation
          • Create Group
          • Create IP Allowlist
          • Create Metrics
          • Create Metrics Token
          • Create Notebook
          • Create Organization
          • Create Organization Invite
          • Create Private
          • Create Private Endpoint
          • Create Private Endpoint Service
          • Create Project
          • Create Role
        • Delete
          • Delete API Key
          • Delete Audit Log
          • Delete Audit Log Archive
          • Delete Audit Log Archive Events
          • Delete Audit Log Destination
          • Delete Backup
          • Delete Backup Policy
          • Delete CA Certificate
          • Delete Deployment
          • Delete Example
          • Delete Example Installation
          • Delete Group
          • Delete Group Members
          • Delete IP Allowlist
          • Delete Metrics
          • Delete Metrics Token
          • Delete Notebook
          • Delete Organization
          • Delete Organization Invite
          • Delete Organization Members
          • Delete Project
          • Delete Role
        • Disable
          • Disable Scheduled-Root-Password-Rotation
        • Enable
          • Enable Scheduled-Root-Password-Rotation
        • Generate Documentation
        • Get
          • Get Audit Log
          • Get Audit Log Archive
          • Get Audit Log Events
          • Get Backup
          • Get Backup Policy
          • Get CA Certificate
          • Get Deployment
          • Get Example
          • Get Example Installation
          • Get Group
          • Get IP Allowlist
          • Get Metrics
          • Get Metrics Token
          • Get Notebook
          • Get Organization
          • Get Organization Authentication
          • Get Organization Authentication Providers
          • Get Organization Email
          • Get Organization Email Domain
          • Get Organization Email Domain Restrictions
          • Get Organization Invite
          • Get Policy
          • Get Private
          • Get Private Endpoint
          • Get Private Endpoint Service
          • Get Project
          • Get Provider
          • Get Region
          • Get Role
          • Get Self
          • Get Server
          • Get Server Status
          • Get Terms & Conditions
        • Import
        • List
          • List API Keys
          • List ArangoDB
          • List ArangoDB Versions
          • List Audit Log
          • List Audit Log Archives
          • List Audit Log Destinations
          • List Audit Logs
          • List Backup
          • List Backup Policies
          • List Backups
          • List CA Certificates
          • List CPU Sizes
          • List Deployments
          • List Disk Performances
          • List Effective
          • List Effective Permissions
          • List Example
          • List Example Installations
          • List Examples
          • List Group
          • List Group Members
          • List Groups
          • List IP Allowlists
          • List Metrics
          • List Metrics Tokens
          • List Node Sizes
          • List Notebook Models
          • List Notebooks
          • List Organization
          • List Organization Invites
          • List Organization Members
          • List Organizations
          • List Permissions
          • List Projects
          • List Providers
          • List Regions
          • List Roles
          • List Servers
        • Lock
          • Lock CA Certificate
          • Lock Deployment
          • Lock IP Allowlist
          • Lock Organization
          • Lock Policy
          • Lock Project
        • Login
        • Logs
        • Pause
          • Pause Notebook
        • Rebalance
          • Rebalance Deployment
          • Rebalance Deployment Shards
        • Reject
          • Reject Organization
          • Reject Organization Invite
        • Renew
          • Renew API Key
          • Renew API Key Token
        • Resume
          • Resume Deployment
          • Resume Notebook
        • Revoke
          • Revoke API Key
          • Revoke API Key Token
          • Revoke Metrics
          • Revoke Metrics Token
        • Rotate
          • Rotate Deployment
          • Rotate Deployment Server
        • Top
        • Unlock
          • Unlock CA Certificate
          • Unlock Deployment
          • Unlock IP Allowlist
          • Unlock Organization
          • Unlock Policy
          • Unlock Project
        • Update
          • Update Audit Log
          • Update Backup
          • Update Backup Policy
          • Update CA Certificate
          • Update Deployment
          • Update Group
          • Update IP Allowlist
          • Update Metrics
          • Update Metrics Token
          • Update Notebook
          • Update Organization
          • Update Organization Authentication
          • Update Organization Authentication Providers
          • Update Organization Email
          • Update Organization Email Domain
          • Update Organization Email Domain Restrictions
          • Update Policy
          • Update Policy Add
          • Update Policy Add Binding
          • Update Policy Delete
          • Update Policy Delete Binding
          • Update Private
          • Update Private Endpoint
          • Update Private Endpoint Service
          • Update Project
          • Update Role
        • Upgrade
        • Version
        • Wait
          • Wait Deployment
    • AQL
      • How to invoke AQL
        • with arangosh
        • with the Web Interface
      • Fundamentals
        • Syntax
        • Data types
        • Bind Parameters
        • Type and value order
        • Accessing data from collections
        • Subqueries
        • Query Results
        • Query Errors
        • Limitations
      • Operators
      • Data Queries
      • High-level Operations
        • FOR
        • RETURN
        • FILTER
        • SEARCH
        • SORT
        • LIMIT
        • LET
        • COLLECT
        • WINDOW
        • REMOVE
        • UPDATE
        • REPLACE
        • INSERT
        • UPSERT
        • WITH
      • Functions
        • ArangoSearch
        • Array
        • Bit
        • Date
        • Document / Object
        • Fulltext
        • Geo
        • Miscellaneous
        • Numeric
        • String
        • Type check & cast
      • Graphs
        • Traversals explained
        • Traversals
        • Shortest Path
        • All Shortest Paths
        • k Shortest Paths
        • k Paths
      • Examples & Query Patterns
        • Create Test Data
        • Counting
        • Dynamic Attribute Names
        • Projections and filters
        • Joins
        • Grouping
        • Actors & Movies Dataset Queries
        • Traversals
        • Remove vertex
        • Queries without collections
        • Diffing Two Documents
        • Upsert / Repsert Guide
      • User-defined Functions
      • Execution and Performance
        • Query statistics
        • Parsing queries
        • Explaining queries
        • Query Profiling
        • Query Optimization
        • Caching query results
      • Common Errors
    • Graphs
      • General Graphs
        • Management
        • Functions
      • SatelliteGraphs
        • Management
        • Details
      • SmartGraphs
        • Getting Started
        • Management
        • Testing Graphs on Single Server
      • EnterpriseGraphs
        • Getting Started
        • Management
      • Working with Edges
      • Example graphs
    • Data Science
      • ArangoGraphML
        • Deploy
        • Getting Started
      • ArangoGraph Notebooks
      • Large Language Models and Knowledge Graphs
      • Pregel
        • Pregel Algorithms
      • Adapters
        • NetworkX
        • cuGraph
        • PyG
        • DGL
        • RDF
    • Index and Search
      • Indexing
        • Index Basics
        • Which index to use when
        • Index Utilization
        • Working with Indexes
          • Persistent Indexes
          • Inverted Indexes
          • TTL Indexes
          • Fulltext Indexes
          • Multi-dimensional Indexes
          • Geo-spatial Indexes
          • Vertex-Centric Indexes
      • ArangoSearch
        • Example Datasets
        • Exact value matching
        • Range Queries
        • Prefix matching
        • Case-sensitivity and Diacritics
        • Wildcard search
        • Full-text token search
        • Phrase and proximity search
        • Faceted search
        • Fuzzy search
        • Geospatial search
        • Search highlighting
        • Nested search
        • Ranking
        • Performance
        • search-alias Views Reference
        • arangosearch Views Reference
      • Analyzers
    • Components
      • ArangoDB Server
        • Options
        • LDAP
        • Environment variables
        • Storage Engine
      • Web Interface
        • Dashboard
        • Cluster
        • Collections
        • Document
        • Queries
        • Graphs
        • Services
        • Users
        • Logs
      • Tools
        • ArangoDB Shell
          • Examples
          • Details
          • Options
        • ArangoDB Starter
          • Options
          • Security
          • Architecture
        • arangodump
          • Examples
          • Options
          • Maskings
          • Limitations
        • arangorestore
          • Examples
          • Fast Cluster Restore
          • Options
        • arangobackup
          • Examples
          • Options
        • arangoimport
          • Examples JSON
          • Examples CSV
          • Details
          • Options
        • arangoexport
          • Examples
          • Options
        • arangobench
          • Options
        • arangovpack
          • Options
        • arangoinspect
          • Examples
          • Options
        • Foxx CLI
          • Details
    • Deploy
      • Single instance
        • Manual Start
        • Using the ArangoDB Starter
      • Active Failover
        • Manual Start
        • Using the ArangoDB Starter
        • Administration
      • Cluster
        • Deployment
          • Manual Start
          • Using the ArangoDB Starter
        • Administration
        • Limitations
      • OneShard
      • Datacenter-to-Datacenter Replication
        • Deployment
          • ArangoDB Cluster
          • ArangoSync Master
          • ArangoSync Workers
          • Prometheus & Grafana
        • Administration
        • Operations & Maintenance
        • Security
        • Monitoring
        • Troubleshooting
      • Kubernetes
      • In the Cloud
      • Single instance vs. Cluster
      • Production Checklist
      • Architecture
        • Scalability
        • Data Sharding
        • Replication
    • Operations
      • Installation
        • Docker
        • Linux
          • Operating System Configuration
          • Linux OS Tuning Script Examples
        • macOS
        • Windows
        • Compiling
          • Compile on Debian
          • Compile on Windows
          • Running Custom Build
          • Recompiling jemalloc
        • Uninstallation
      • Backup & Restore
      • Upgrading
        • Community to Enterprise Edition
        • OS-specific Information
          • Linux
          • macOS
          • Windows
        • Starter Deployments
        • Manual Deployments
          • Active Failover
          • Cluster
        • Downgrading
      • Administration
        • Configuration
        • Log Levels
        • License Management
        • Import & Export
        • User Management
          • In arangosh
        • ArangoDB Starter Administration
          • Removal Procedure
          • Recovery Procedure
        • Reduce Memory Footprint
      • Security
        • Security Options
        • Change Root Password
        • Encryption at Rest
        • Audit logging
        • Securing Starter Deployments
      • Troubleshooting
        • Query debug packages
        • arangod
        • Emergency Console
        • Cluster
          • Agency Dump
    • Develop
      • Operational Factors
      • SatelliteCollections
      • SmartJoins
      • Transactions
        • JavaScript Transactions
        • Stream Transactions
        • Locking and isolation
        • Durability
        • Limitations
      • Foxx Microservices
        • Getting started
        • Guides
          • Working with routers
          • Working with collections
          • Writing queries
          • Development mode
          • Testing Foxx services
          • Foxx in a cluster
          • Scripts and scheduling
          • Using Node modules
          • Using Webpack with Foxx
          • Authentication and sessions
          • Linking services together
          • Working with files
          • Making requests
          • Access from the browser
        • Deployment
        • Reference
          • Service manifest
          • Service context
          • Configuration
          • Routers
            • Endpoints
            • Middleware
            • Request
            • Response
          • Sessions middleware
            • Session storages
              • Collection storage
              • JWT storage
            • Session transports
              • Cookie transport
              • Header transport
          • Related modules
            • Authentication
            • OAuth 1.0a
            • OAuth 2.0
            • GraphQL
            • Queues
      • JavaScript API
        • @arangodb
          • db object
          • collection object
          • view object
          • cursor object
        • @arangodb/actions
        • @arangodb/analyzers
        • @arangodb/aql/queries
        • @arangodb/crypto
        • @arangodb/request
        • @arangodb/tasks
        • console
        • fs
      • HTTP API
        • General request handling
        • Authentication
        • Users
        • Databases
        • Collections
        • Documents
        • Graphs
          • Named graphs
          • Edges
        • Queries
          • AQL queries
          • AQL query results cache
          • User-defined AQL functions
        • Pregel
        • Transactions
          • Stream Transactions
          • JavaScript Transactions
        • Indexes
          • Persistent
          • Inverted
          • TTL
          • Multi-dimensional
          • Geo-Spatial
          • Fulltext
        • Views
          • search-alias Views
          • arangosearch Views
        • Analyzers
        • Import
        • Foxx
        • Jobs
        • Tasks
        • Batch Requests
        • Replication
          • Replication Dump
          • Replication Logger
          • Replication Applier
          • Other Replication Commands
          • Write-Ahead Log
        • Monitoring
          • Logs
          • Statistics
          • Metrics
        • Security
        • Administration
        • Cluster
        • Hot Backups
      • Error codes and meanings
      • Drivers
        • Java driver
          • Reference version 7
            • Driver Setup
            • Serialization
            • Changes in version 7
          • Reference version 6
            • Driver Setup
            • Serialization
        • Go driver
        • C#/.NET driver
        • Node.js driver
        • Python driver
      • Integrations
        • Spring Data
          • Reference version 4
            • Template
            • Repositories
              • Queries
                • Derived queries
                • Query methods
                • Named queries
            • Mapping
              • Document
              • Edge
              • Reference
              • Relations
              • Indexes
              • Computed Values
              • Converter
              • Events
              • Auditing
          • Reference version 3
            • Template
            • Repositories
              • Queries
                • Derived queries
                • Query methods
                • Named queries
            • Mapping
              • Document
              • Edge
              • Reference
              • Relations
              • Indexes
              • Converter
              • Events
              • Auditing
          • Migration
        • Spring Boot Starter
        • Datasource for Apache Spark
        • Kafka Connector
          • Configuration
    • Release Notes
      • Version 3.10
        • What’s New in 3.10
        • Known Issues in 3.10
        • Incompatible changes in 3.10
        • API changes in 3.10
      • Version 3.9
        • What’s New in 3.9
        • Known Issues in 3.9
        • Incompatible changes in 3.9
        • API changes in 3.9
      • Version 3.8
        • What’s New in 3.8
        • Known Issues in 3.8
        • Incompatible changes in 3.8
        • API changes in 3.8
      • Version 3.7
        • What’s New in 3.7
        • Known Issues in 3.7
        • Incompatible changes in 3.7
        • API changes in 3.7
      • Version 3.6
        • What’s New in 3.6
        • Known Issues in 3.6
        • Incompatible changes in 3.6
      • Version 3.5
        • What’s New in 3.5
        • Known Issues in 3.5
        • Incompatible changes in 3.5
      • Version 3.4
        • What’s New in 3.4
        • Known Issues in 3.4
        • Incompatible changes in 3.4
      • Version 3.3
        • What’s New in 3.3
        • Known Issues in 3.3
        • Incompatible changes in 3.3
      • Version 3.2
        • What’s New in 3.2
        • Known Issues in 3.2
        • Incompatible changes in 3.2
      • Version 3.1
        • What’s New in 3.1
        • Incompatible changes in 3.1
      • Version 3.0
        • What’s New in 3.0
        • Incompatible changes in 3.0
      • Deprecated and removed features
    • About ArangoDB
      • Use Cases
      • Features
        • Community Edition
        • Enterprise Edition
        • Highlights by Version
    • Get Started
      • Set up a cloud instance
      • On-premises installation
      • Start using AQL
      • How to Interact with ArangoDB
    • Concepts
      • Data Structure
        • Databases
        • Collections
        • Documents
          • Schema Validation
          • Computed Values
        • Views
      • Data Models
      • Data Retrieval
    • ArangoGraph
      • Organizations
        • Users & Groups
        • Billing
        • Credits & Usage
      • Projects
      • Deployments
        • Private endpoints
        • Upgrades and Versioning
      • Data Loader
        • Add files
        • Design graph
        • Start import
        • Example
      • Notebooks
      • My Account
      • Monitoring & Metrics
      • Security and Access Control
        • X.509 Certificates
        • Single Sign-On
          • SCIM Provisioning
      • Backups
      • ArangoGraph API
        • Get started with the API
        • Get started with Oasisctl
      • Oasisctl
        • Options
        • Accept
          • Accept Organization
          • Accept Organization Invite
        • Add
          • Add Audit Log
          • Add Audit Log Destination
          • Add Group
          • Add Group Members
        • Audit Log
          • Audit Log Attach
          • Audit Log Detach
          • Audit Log Get
          • Audit Log Get Attached
          • Audit Log Get Attached Project
        • Backup
          • Backup Copy
          • Backup Download
        • Clone
          • Clone Deployment
          • Clone Deployment Backup
        • Completion
        • Create
          • Create API Key
          • Create Audit Log
          • Create Backup
          • Create Backup Policy
          • Create CA Certificate
          • Create Deployment
          • Create Example
          • Create Example Installation
          • Create Group
          • Create IP Allowlist
          • Create Metrics
          • Create Metrics Token
          • Create Notebook
          • Create Organization
          • Create Organization Invite
          • Create Private
          • Create Private Endpoint
          • Create Private Endpoint Service
          • Create Project
          • Create Role
        • Delete
          • Delete API Key
          • Delete Audit Log
          • Delete Audit Log Archive
          • Delete Audit Log Archive Events
          • Delete Audit Log Destination
          • Delete Backup
          • Delete Backup Policy
          • Delete CA Certificate
          • Delete Deployment
          • Delete Example
          • Delete Example Installation
          • Delete Group
          • Delete Group Members
          • Delete IP Allowlist
          • Delete Metrics
          • Delete Metrics Token
          • Delete Notebook
          • Delete Organization
          • Delete Organization Invite
          • Delete Organization Members
          • Delete Project
          • Delete Role
        • Disable
          • Disable Scheduled-Root-Password-Rotation
        • Enable
          • Enable Scheduled-Root-Password-Rotation
        • Generate Documentation
        • Get
          • Get Audit Log
          • Get Audit Log Archive
          • Get Audit Log Events
          • Get Backup
          • Get Backup Policy
          • Get CA Certificate
          • Get Deployment
          • Get Example
          • Get Example Installation
          • Get Group
          • Get IP Allowlist
          • Get Metrics
          • Get Metrics Token
          • Get Notebook
          • Get Organization
          • Get Organization Authentication
          • Get Organization Authentication Providers
          • Get Organization Email
          • Get Organization Email Domain
          • Get Organization Email Domain Restrictions
          • Get Organization Invite
          • Get Policy
          • Get Private
          • Get Private Endpoint
          • Get Private Endpoint Service
          • Get Project
          • Get Provider
          • Get Region
          • Get Role
          • Get Self
          • Get Server
          • Get Server Status
          • Get Terms & Conditions
        • Import
        • List
          • List API Keys
          • List ArangoDB
          • List ArangoDB Versions
          • List Audit Log
          • List Audit Log Archives
          • List Audit Log Destinations
          • List Audit Logs
          • List Backup
          • List Backup Policies
          • List Backups
          • List CA Certificates
          • List CPU Sizes
          • List Deployments
          • List Disk Performances
          • List Effective
          • List Effective Permissions
          • List Example
          • List Example Installations
          • List Examples
          • List Group
          • List Group Members
          • List Groups
          • List IP Allowlists
          • List Metrics
          • List Metrics Tokens
          • List Node Sizes
          • List Notebook Models
          • List Notebooks
          • List Organization
          • List Organization Invites
          • List Organization Members
          • List Organizations
          • List Permissions
          • List Projects
          • List Providers
          • List Regions
          • List Roles
          • List Servers
        • Lock
          • Lock CA Certificate
          • Lock Deployment
          • Lock IP Allowlist
          • Lock Organization
          • Lock Policy
          • Lock Project
        • Login
        • Logs
        • Pause
          • Pause Notebook
        • Rebalance
          • Rebalance Deployment
          • Rebalance Deployment Shards
        • Reject
          • Reject Organization
          • Reject Organization Invite
        • Renew
          • Renew API Key
          • Renew API Key Token
        • Resume
          • Resume Deployment
          • Resume Notebook
        • Revoke
          • Revoke API Key
          • Revoke API Key Token
          • Revoke Metrics
          • Revoke Metrics Token
        • Rotate
          • Rotate Deployment
          • Rotate Deployment Server
        • Top
        • Unlock
          • Unlock CA Certificate
          • Unlock Deployment
          • Unlock IP Allowlist
          • Unlock Organization
          • Unlock Policy
          • Unlock Project
        • Update
          • Update Audit Log
          • Update Backup
          • Update Backup Policy
          • Update CA Certificate
          • Update Deployment
          • Update Group
          • Update IP Allowlist
          • Update Metrics
          • Update Metrics Token
          • Update Notebook
          • Update Organization
          • Update Organization Authentication
          • Update Organization Authentication Providers
          • Update Organization Email
          • Update Organization Email Domain
          • Update Organization Email Domain Restrictions
          • Update Policy
          • Update Policy Add
          • Update Policy Add Binding
          • Update Policy Delete
          • Update Policy Delete Binding
          • Update Private
          • Update Private Endpoint
          • Update Private Endpoint Service
          • Update Project
          • Update Role
        • Upgrade
        • Version
        • Wait
          • Wait Deployment
    • AQL
      • How to invoke AQL
        • with arangosh
        • with the Web Interface
      • Fundamentals
        • Syntax
        • Data types
        • Bind Parameters
        • Type and value order
        • Accessing data from collections
        • Subqueries
        • Query Results
        • Query Errors
        • Limitations
      • Operators
      • Data Queries
      • High-level Operations
        • FOR
        • RETURN
        • FILTER
        • SEARCH
        • SORT
        • LIMIT
        • LET
        • COLLECT
        • WINDOW
        • REMOVE
        • UPDATE
        • REPLACE
        • INSERT
        • UPSERT
        • WITH
      • Functions
        • ArangoSearch
        • Array
        • Bit
        • Date
        • Document / Object
        • Fulltext
        • Geo
        • Miscellaneous
        • Numeric
        • String
        • Type check & cast
      • Graphs
        • Traversals explained
        • Traversals
        • Shortest Path
        • All Shortest Paths
        • k Shortest Paths
        • k Paths
      • Examples & Query Patterns
        • Create Test Data
        • Counting
        • Dynamic Attribute Names
        • Projections and filters
        • Joins
        • Grouping
        • Actors & Movies Dataset Queries
        • Traversals
        • Remove vertex
        • Queries without collections
        • Diffing Two Documents
        • Upsert / Repsert Guide
      • User-defined Functions
      • Execution and Performance
        • Query statistics
        • Parsing queries
        • Explaining queries
        • Query Profiling
        • Query Optimization
        • Caching query results
      • Common Errors
    • Graphs
      • General Graphs
        • Management
        • Functions
      • SatelliteGraphs
        • Management
        • Details
      • SmartGraphs
        • Getting Started
        • Management
        • Testing Graphs on Single Server
      • EnterpriseGraphs
        • Getting Started
        • Management
      • Working with Edges
      • Example graphs
    • Data Science
      • Graph Analytics
      • ArangoGraphML
        • Deploy
        • Getting Started
      • ArangoGraph Notebooks
      • Large Language Models and Knowledge Graphs
      • Pregel
        • Pregel Algorithms
      • Adapters
        • NetworkX
        • cuGraph
        • PyG
        • DGL
        • RDF
    • Index and Search
      • Indexing
        • Index Basics
        • Which index to use when
        • Index Utilization
        • Working with Indexes
          • Persistent Indexes
          • Inverted Indexes
          • TTL Indexes
          • Fulltext Indexes
          • Multi-dimensional Indexes
          • Geo-spatial Indexes
          • Vertex-Centric Indexes
      • ArangoSearch
        • Example Datasets
        • Exact value matching
        • Range Queries
        • Prefix matching
        • Case-sensitivity and Diacritics
        • Wildcard search
        • Full-text token search
        • Phrase and proximity search
        • Faceted search
        • Fuzzy search
        • Geospatial search
        • Search highlighting
        • Nested search
        • Ranking
        • Performance
        • search-alias Views Reference
        • arangosearch Views Reference
      • Analyzers
    • Components
      • ArangoDB Server
        • Options
        • LDAP
        • Environment variables
        • Storage Engine
      • Web Interface
        • Dashboard
        • Cluster
        • Collections
        • Document
        • Queries
        • Graphs
        • Services
        • Users
        • Logs
      • Tools
        • ArangoDB Shell
          • Examples
          • Details
          • Options
        • ArangoDB Starter
          • Options
          • Security
          • Architecture
        • arangodump
          • Examples
          • Options
          • Maskings
          • Limitations
        • arangorestore
          • Examples
          • Options
        • arangobackup
          • Examples
          • Options
        • arangoimport
          • Examples JSON
          • Examples CSV
          • Details
          • Options
        • arangoexport
          • Examples
          • Options
        • arangobench
          • Options
        • arangovpack
          • Options
        • arangoinspect
          • Examples
          • Options
        • Foxx CLI
          • Details
        • ArangoDB Datasets
    • Deploy
      • Single instance
        • Manual Start
        • Using the ArangoDB Starter
      • Active Failover
        • Manual Start
        • Using the ArangoDB Starter
        • Administration
      • Cluster
        • Deployment
          • Manual Start
          • Using the ArangoDB Starter
        • Administration
        • Limitations
      • OneShard
      • Datacenter-to-Datacenter Replication
        • Deployment
          • ArangoDB Cluster
          • ArangoSync Master
          • ArangoSync Workers
          • Prometheus & Grafana
        • Administration
        • Operations & Maintenance
        • Security
        • Monitoring
        • Troubleshooting
      • Kubernetes
      • In the Cloud
      • Single instance vs. Cluster
      • Production Checklist
      • Architecture
        • Scalability
        • Data Sharding
        • Replication
    • Operations
      • Installation
        • Docker
        • Linux
          • Operating System Configuration
          • Linux OS Tuning Script Examples
        • macOS
        • Windows
        • Compiling
          • Compile on Debian
          • Compile on Windows
          • Running Custom Build
          • Recompiling jemalloc
        • Uninstallation
      • Backup & Restore
      • Upgrading
        • Community to Enterprise Edition
        • OS-specific Information
          • Linux
          • macOS
          • Windows
        • Starter Deployments
        • Manual Deployments
          • Active Failover
          • Cluster
        • Downgrading
      • Administration
        • Configuration
        • Telemetrics
        • Log Levels
        • License Management
        • Import & Export
        • User Management
          • In arangosh
        • ArangoDB Starter Administration
          • Removal Procedure
          • Recovery Procedure
        • Reduce Memory Footprint
      • Security
        • Security Options
        • Change Root Password
        • Encryption at Rest
        • Audit logging
        • Securing Starter Deployments
      • Troubleshooting
        • Query debug packages
        • arangod
        • Emergency Console
        • Cluster
          • Agency Dump
    • Develop
      • Operational Factors
      • SatelliteCollections
      • SmartJoins
      • Transactions
        • JavaScript Transactions
        • Stream Transactions
        • Locking and isolation
        • Durability
        • Limitations
      • Foxx Microservices
        • Getting started
        • Guides
          • Working with routers
          • Working with collections
          • Writing queries
          • Development mode
          • Testing Foxx services
          • Foxx in a cluster
          • Scripts and scheduling
          • Using Node modules
          • Using Webpack with Foxx
          • Authentication and sessions
          • Linking services together
          • Working with files
          • Making requests
          • Access from the browser
        • Deployment
        • Reference
          • Service manifest
          • Service context
          • Configuration
          • Routers
            • Endpoints
            • Middleware
            • Request
            • Response
          • Sessions middleware
            • Session storages
              • Collection storage
              • JWT storage
            • Session transports
              • Cookie transport
              • Header transport
          • Related modules
            • Authentication
            • OAuth 1.0a
            • OAuth 2.0
            • GraphQL
            • Queues
      • JavaScript API
        • @arangodb
          • db object
          • collection object
          • view object
          • cursor object
        • @arangodb/actions
        • @arangodb/analyzers
        • @arangodb/aql/queries
        • @arangodb/crypto
        • @arangodb/request
        • @arangodb/tasks
        • console
        • fs
      • HTTP API
        • General request handling
        • Authentication
        • Users
        • Databases
        • Collections
        • Documents
        • Graphs
          • Named graphs
          • Edges
        • Queries
          • AQL queries
          • AQL query results cache
          • User-defined AQL functions
        • Pregel
        • Transactions
          • Stream Transactions
          • JavaScript Transactions
        • Indexes
          • Persistent
          • Inverted
          • TTL
          • Multi-dimensional
          • Geo-Spatial
          • Fulltext
        • Views
          • search-alias Views
          • arangosearch Views
        • Analyzers
        • Import
        • Foxx
        • Jobs
        • Tasks
        • Batch Requests
        • Replication
          • Replication Dump
          • Replication Logger
          • Replication Applier
          • Other Replication Commands
          • Write-Ahead Log
        • Monitoring
          • Logs
          • Statistics
          • Metrics
        • Security
        • Administration
        • Cluster
        • Hot Backups
      • Error codes and meanings
      • Drivers
        • Java driver
          • Reference version 7
            • Driver Setup
            • Serialization
            • Changes in version 7
          • Reference version 6
            • Driver Setup
            • Serialization
        • Go driver
        • Node.js driver
        • Python driver
      • Integrations
        • Spring Data
          • Reference version 4
            • Template
            • Repositories
              • Queries
                • Derived queries
                • Query methods
                • Named queries
            • Mapping
              • Document
              • Edge
              • Reference
              • Relations
              • Indexes
              • Computed Values
              • Converter
              • Events
              • Auditing
          • Reference version 3
            • Template
            • Repositories
              • Queries
                • Derived queries
                • Query methods
                • Named queries
            • Mapping
              • Document
              • Edge
              • Reference
              • Relations
              • Indexes
              • Converter
              • Events
              • Auditing
          • Migration
        • Spring Boot Starter
        • Datasource for Apache Spark
        • Kafka Connector
          • Configuration
    • Release Notes
      • Version 3.11
        • What’s New in 3.11
        • Known Issues in 3.11
        • Incompatible changes in 3.11
        • API changes in 3.11
      • Version 3.10
        • What’s New in 3.10
        • Known Issues in 3.10
        • Incompatible changes in 3.10
        • API changes in 3.10
      • Version 3.9
        • What’s New in 3.9
        • Known Issues in 3.9
        • Incompatible changes in 3.9
        • API changes in 3.9
      • Version 3.8
        • What’s New in 3.8
        • Known Issues in 3.8
        • Incompatible changes in 3.8
        • API changes in 3.8
      • Version 3.7
        • What’s New in 3.7
        • Known Issues in 3.7
        • Incompatible changes in 3.7
        • API changes in 3.7
      • Version 3.6
        • What’s New in 3.6
        • Known Issues in 3.6
        • Incompatible changes in 3.6
      • Version 3.5
        • What’s New in 3.5
        • Known Issues in 3.5
        • Incompatible changes in 3.5
      • Version 3.4
        • What’s New in 3.4
        • Known Issues in 3.4
        • Incompatible changes in 3.4
      • Version 3.3
        • What’s New in 3.3
        • Known Issues in 3.3
        • Incompatible changes in 3.3
      • Version 3.2
        • What’s New in 3.2
        • Known Issues in 3.2
        • Incompatible changes in 3.2
      • Version 3.1
        • What’s New in 3.1
        • Incompatible changes in 3.1
      • Version 3.0
        • What’s New in 3.0
        • Incompatible changes in 3.0
      • Deprecated and removed features
    • About ArangoDB
      • Use Cases
      • Features
        • Community Edition
        • Enterprise Edition
        • Highlights by Version
    • Get Started
      • Set up a cloud instance
      • On-premises installation
      • Start using AQL
      • How to Interact with ArangoDB
    • Concepts
      • Data Structure
        • Databases
        • Collections
        • Documents
          • Schema Validation
          • Computed Values
        • Views
      • Data Models
      • Data Retrieval
    • ArangoGraph
      • Organizations
        • Users & Groups
        • Billing
        • Credits & Usage
      • Projects
      • Deployments
        • Private endpoints
        • Upgrades and Versioning
      • Data Loader
        • Add files
        • Design graph
        • Start import
        • Example
      • Notebooks
      • My Account
      • Monitoring & Metrics
      • Security and Access Control
        • X.509 Certificates
        • Single Sign-On
          • SCIM Provisioning
      • Backups
      • ArangoGraph API
        • Get started with the API
        • Get started with Oasisctl
      • Oasisctl
        • Options
        • Accept
          • Accept Organization
          • Accept Organization Invite
        • Add
          • Add Audit Log
          • Add Audit Log Destination
          • Add Group
          • Add Group Members
        • Audit Log
          • Audit Log Attach
          • Audit Log Detach
          • Audit Log Get
          • Audit Log Get Attached
          • Audit Log Get Attached Project
        • Backup
          • Backup Copy
          • Backup Download
        • Clone
          • Clone Deployment
          • Clone Deployment Backup
        • Completion
        • Create
          • Create API Key
          • Create Audit Log
          • Create Backup
          • Create Backup Policy
          • Create CA Certificate
          • Create Deployment
          • Create Example
          • Create Example Installation
          • Create Group
          • Create IP Allowlist
          • Create Metrics
          • Create Metrics Token
          • Create Notebook
          • Create Organization
          • Create Organization Invite
          • Create Private
          • Create Private Endpoint
          • Create Private Endpoint Service
          • Create Project
          • Create Role
        • Delete
          • Delete API Key
          • Delete Audit Log
          • Delete Audit Log Archive
          • Delete Audit Log Archive Events
          • Delete Audit Log Destination
          • Delete Backup
          • Delete Backup Policy
          • Delete CA Certificate
          • Delete Deployment
          • Delete Example
          • Delete Example Installation
          • Delete Group
          • Delete Group Members
          • Delete IP Allowlist
          • Delete Metrics
          • Delete Metrics Token
          • Delete Notebook
          • Delete Organization
          • Delete Organization Invite
          • Delete Organization Members
          • Delete Project
          • Delete Role
        • Disable
          • Disable Scheduled-Root-Password-Rotation
        • Enable
          • Enable Scheduled-Root-Password-Rotation
        • Generate Documentation
        • Get
          • Get Audit Log
          • Get Audit Log Archive
          • Get Audit Log Events
          • Get Backup
          • Get Backup Policy
          • Get CA Certificate
          • Get Deployment
          • Get Example
          • Get Example Installation
          • Get Group
          • Get IP Allowlist
          • Get Metrics
          • Get Metrics Token
          • Get Notebook
          • Get Organization
          • Get Organization Authentication
          • Get Organization Authentication Providers
          • Get Organization Email
          • Get Organization Email Domain
          • Get Organization Email Domain Restrictions
          • Get Organization Invite
          • Get Policy
          • Get Private
          • Get Private Endpoint
          • Get Private Endpoint Service
          • Get Project
          • Get Provider
          • Get Region
          • Get Role
          • Get Self
          • Get Server
          • Get Server Status
          • Get Terms & Conditions
        • Import
        • List
          • List API Keys
          • List ArangoDB
          • List ArangoDB Versions
          • List Audit Log
          • List Audit Log Archives
          • List Audit Log Destinations
          • List Audit Logs
          • List Backup
          • List Backup Policies
          • List Backups
          • List CA Certificates
          • List CPU Sizes
          • List Deployments
          • List Disk Performances
          • List Effective
          • List Effective Permissions
          • List Example
          • List Example Installations
          • List Examples
          • List Group
          • List Group Members
          • List Groups
          • List IP Allowlists
          • List Metrics
          • List Metrics Tokens
          • List Node Sizes
          • List Notebook Models
          • List Notebooks
          • List Organization
          • List Organization Invites
          • List Organization Members
          • List Organizations
          • List Permissions
          • List Projects
          • List Providers
          • List Regions
          • List Roles
          • List Servers
        • Lock
          • Lock CA Certificate
          • Lock Deployment
          • Lock IP Allowlist
          • Lock Organization
          • Lock Policy
          • Lock Project
        • Login
        • Logs
        • Pause
          • Pause Notebook
        • Rebalance
          • Rebalance Deployment
          • Rebalance Deployment Shards
        • Reject
          • Reject Organization
          • Reject Organization Invite
        • Renew
          • Renew API Key
          • Renew API Key Token
        • Resume
          • Resume Deployment
          • Resume Notebook
        • Revoke
          • Revoke API Key
          • Revoke API Key Token
          • Revoke Metrics
          • Revoke Metrics Token
        • Rotate
          • Rotate Deployment
          • Rotate Deployment Server
        • Top
        • Unlock
          • Unlock CA Certificate
          • Unlock Deployment
          • Unlock IP Allowlist
          • Unlock Organization
          • Unlock Policy
          • Unlock Project
        • Update
          • Update Audit Log
          • Update Backup
          • Update Backup Policy
          • Update CA Certificate
          • Update Deployment
          • Update Group
          • Update IP Allowlist
          • Update Metrics
          • Update Metrics Token
          • Update Notebook
          • Update Organization
          • Update Organization Authentication
          • Update Organization Authentication Providers
          • Update Organization Email
          • Update Organization Email Domain
          • Update Organization Email Domain Restrictions
          • Update Policy
          • Update Policy Add
          • Update Policy Add Binding
          • Update Policy Delete
          • Update Policy Delete Binding
          • Update Private
          • Update Private Endpoint
          • Update Private Endpoint Service
          • Update Project
          • Update Role
        • Upgrade
        • Version
        • Wait
          • Wait Deployment
    • AQL
      • How to invoke AQL
        • with arangosh
        • with the Web Interface
      • Fundamentals
        • Syntax
        • Data types
        • Bind Parameters
        • Type and value order
        • Accessing data from collections
        • Subqueries
        • Query Results
        • Query Errors
        • Limitations
      • Operators
      • Data Queries
      • High-level Operations
        • FOR
        • RETURN
        • FILTER
        • SEARCH
        • SORT
        • LIMIT
        • LET
        • COLLECT
        • WINDOW
        • REMOVE
        • UPDATE
        • REPLACE
        • INSERT
        • UPSERT
        • WITH
      • Functions
        • ArangoSearch
        • Array
        • Bit
        • Date
        • Document / Object
        • Fulltext
        • Geo
        • Miscellaneous
        • Numeric
        • String
        • Type check & cast
      • Graphs
        • Traversals explained
        • Traversals
        • Shortest Path
        • All Shortest Paths
        • k Shortest Paths
        • k Paths
      • Examples & Query Patterns
        • Create Test Data
        • Counting
        • Dynamic Attribute Names
        • Projections and filters
        • Joins
        • Grouping
        • Actors & Movies Dataset Queries
        • Traversals
        • Remove vertex
        • Queries without collections
        • Diffing Two Documents
        • Upsert / Repsert Guide
      • User-defined Functions
      • Execution and Performance
        • Query statistics
        • Parsing queries
        • Explaining queries
        • Query Profiling
        • Query Optimization
        • Caching query plans
        • Caching query results
        • Query logging
      • Common Errors
    • Graphs
      • General Graphs
        • Management
        • Functions
      • SatelliteGraphs
        • Management
        • Details
      • SmartGraphs
        • Getting Started
        • Management
        • Testing Graphs on Single Server
      • EnterpriseGraphs
        • Getting Started
        • Management
      • Working with Edges
      • Example graphs
    • Data Science
      • Graph Analytics
      • ArangoGraphML
        • Deploy
        • Getting Started
      • ArangoGraph Notebooks
      • Large Language Models and Knowledge Graphs
      • Adapters
        • NetworkX
        • cuGraph
        • PyG
        • DGL
        • RDF
    • Index and Search
      • Indexing
        • Index Basics
        • Which index to use when
        • Index Utilization
        • Working with Indexes
          • Persistent Indexes
          • Inverted Indexes
          • TTL Indexes
          • Fulltext Indexes
          • Multi-dimensional Indexes
          • Geo-spatial Indexes
          • Vertex-Centric Indexes
      • ArangoSearch
        • Example Datasets
        • Exact value matching
        • Range Queries
        • Prefix matching
        • Case-sensitivity and Diacritics
        • Wildcard search
        • Full-text token search
        • Phrase and proximity search
        • Faceted search
        • Fuzzy search
        • Geospatial search
        • Search highlighting
        • Nested search
        • Ranking
        • Performance
        • search-alias Views Reference
        • arangosearch Views Reference
      • Analyzers
    • Components
      • ArangoDB Server
        • Options
        • Environment variables
        • Storage Engine
      • Web Interface
        • Dashboard
        • Cluster
        • Collections
        • Document
        • Queries
        • Graphs
        • Services
        • Users
        • Logs
      • Tools
        • ArangoDB Shell
          • Examples
          • Details
          • Options
        • ArangoDB Starter
          • Options
          • Security
          • Architecture
        • arangodump
          • Examples
          • Options
          • Maskings
          • Limitations
        • arangorestore
          • Examples
          • Options
        • arangobackup
          • Examples
          • Options
        • arangoimport
          • Examples JSON
          • Examples CSV
          • Details
          • Options
        • arangoexport
          • Examples
          • Options
        • arangobench
          • Options
        • arangovpack
          • Options
        • arangoinspect
          • Examples
          • Options
        • Foxx CLI
          • Details
        • ArangoDB Datasets
    • Deploy
      • Single instance
        • Manual Start
        • Using the ArangoDB Starter
      • Cluster
        • Deployment
          • Manual Start
          • Using the ArangoDB Starter
        • Administration
        • Limitations
      • OneShard
      • Kubernetes
      • In the Cloud
      • Single instance vs. Cluster
      • Production Checklist
      • Architecture
        • Scalability
        • Data Sharding
        • Replication
    • Operations
      • Installation
        • Docker
        • Linux
          • Operating System Configuration
          • Linux OS Tuning Script Examples
        • Uninstallation
      • Backup & Restore
      • Upgrading
        • Community to Enterprise Edition
        • Starter Deployments
        • Manual Deployments
          • Single server
          • Cluster
        • Downgrading
      • Administration
        • Configuration
        • Telemetrics
        • Log Levels
        • License Management
        • Import & Export
        • User Management
          • In arangosh
        • ArangoDB Starter Administration
          • Removal Procedure
          • Recovery Procedure
        • Reduce Memory Footprint
      • Security
        • Security Options
        • Change Root Password
        • Encryption at Rest
        • Audit logging
        • Securing Starter Deployments
      • Troubleshooting
        • Query debug packages
        • arangod
        • Emergency Console
        • Cluster
          • Agency Dump
    • Develop
      • Operational Factors
      • SatelliteCollections
      • SmartJoins
      • Transactions
        • JavaScript Transactions
        • Stream Transactions
        • Locking and isolation
        • Durability
        • Limitations
      • Foxx Microservices
        • Getting started
        • Guides
          • Working with routers
          • Working with collections
          • Writing queries
          • Development mode
          • Testing Foxx services
          • Foxx in a cluster
          • Scripts and scheduling
          • Using Node modules
          • Using Webpack with Foxx
          • Authentication and sessions
          • Linking services together
          • Working with files
          • Making requests
          • Access from the browser
        • Deployment
        • Reference
          • Service manifest
          • Service context
          • Configuration
          • Routers
            • Endpoints
            • Middleware
            • Request
            • Response
          • Sessions middleware
            • Session storages
              • Collection storage
              • JWT storage
            • Session transports
              • Cookie transport
              • Header transport
          • Related modules
            • Authentication
            • OAuth 1.0a
            • OAuth 2.0
            • GraphQL
            • Queues
      • JavaScript API
        • @arangodb
          • db object
          • collection object
          • view object
          • cursor object
        • @arangodb/actions
        • @arangodb/analyzers
        • @arangodb/aql/queries
        • @arangodb/crypto
        • @arangodb/request
        • @arangodb/tasks
        • console
        • fs
      • HTTP API
        • General request handling
        • Authentication
        • Users
        • Databases
        • Collections
        • Documents
        • Graphs
          • Named graphs
          • Edges
        • Queries
          • AQL queries
          • AQL query plan cache
          • AQL query results cache
          • User-defined AQL functions
        • Transactions
          • Stream Transactions
          • JavaScript Transactions
        • Indexes
          • Persistent
          • Inverted
          • TTL
          • Multi-dimensional
          • Geo-Spatial
          • Fulltext
        • Views
          • search-alias Views
          • arangosearch Views
        • Analyzers
        • Import
        • Foxx
        • Jobs
        • Tasks
        • Batch Requests
        • Replication
          • Replication Dump
          • Replication Logger
          • Replication Applier
          • Other Replication Commands
          • Write-Ahead Log
        • Monitoring
          • Logs
          • Statistics
          • Metrics
        • Security
        • Administration
        • Cluster
        • Hot Backups
      • Error codes and meanings
      • Drivers
        • Java driver
          • Reference version 7
            • Driver Setup
            • Serialization
            • Changes in version 7
          • Reference version 6
            • Driver Setup
            • Serialization
        • Go driver
        • Node.js driver
        • Python driver
      • Integrations
        • Spring Data
          • Reference version 4
            • Template
            • Repositories
              • Queries
                • Derived queries
                • Query methods
                • Named queries
            • Mapping
              • Document
              • Edge
              • Reference
              • Relations
              • Indexes
              • Computed Values
              • Converter
              • Events
              • Auditing
          • Reference version 3
            • Template
            • Repositories
              • Queries
                • Derived queries
                • Query methods
                • Named queries
            • Mapping
              • Document
              • Edge
              • Reference
              • Relations
              • Indexes
              • Converter
              • Events
              • Auditing
          • Migration
        • Spring Boot Starter
        • Datasource for Apache Spark
        • Kafka Connector
          • Configuration
    • Release Notes
      • Version 3.12
        • What’s New in 3.12
        • Known Issues in 3.12
        • Incompatible changes in 3.12
        • API changes in 3.12
      • Version 3.11
        • What’s New in 3.11
        • Known Issues in 3.11
        • Incompatible changes in 3.11
        • API changes in 3.11
      • Version 3.10
        • What’s New in 3.10
        • Known Issues in 3.10
        • Incompatible changes in 3.10
        • API changes in 3.10
      • Version 3.9
        • What’s New in 3.9
        • Known Issues in 3.9
        • Incompatible changes in 3.9
        • API changes in 3.9
      • Version 3.8
        • What’s New in 3.8
        • Known Issues in 3.8
        • Incompatible changes in 3.8
        • API changes in 3.8
      • Version 3.7
        • What’s New in 3.7
        • Known Issues in 3.7
        • Incompatible changes in 3.7
        • API changes in 3.7
      • Version 3.6
        • What’s New in 3.6
        • Known Issues in 3.6
        • Incompatible changes in 3.6
      • Version 3.5
        • What’s New in 3.5
        • Known Issues in 3.5
        • Incompatible changes in 3.5
      • Version 3.4
        • What’s New in 3.4
        • Known Issues in 3.4
        • Incompatible changes in 3.4
      • Version 3.3
        • What’s New in 3.3
        • Known Issues in 3.3
        • Incompatible changes in 3.3
      • Version 3.2
        • What’s New in 3.2
        • Known Issues in 3.2
        • Incompatible changes in 3.2
      • Version 3.1
        • What’s New in 3.1
        • Incompatible changes in 3.1
      • Version 3.0
        • What’s New in 3.0
        • Incompatible changes in 3.0
      • Deprecated and removed features
    • About ArangoDB
      • Use Cases
      • Features
        • Community Edition
        • Enterprise Edition
        • Highlights by Version
    • Get Started
      • Set up a cloud instance
      • On-premises installation
      • Start using AQL
      • How to Interact with ArangoDB
    • Concepts
      • Data Structure
        • Databases
        • Collections
        • Documents
          • Schema Validation
          • Computed Values
        • Views
      • Data Models
      • Data Retrieval
    • ArangoGraph
      • Organizations
        • Users & Groups
        • Billing
        • Credits & Usage
      • Projects
      • Deployments
        • Private endpoints
        • Upgrades and Versioning
      • Data Loader
        • Add files
        • Design graph
        • Start import
        • Example
      • Notebooks
      • My Account
      • Monitoring & Metrics
      • Security and Access Control
        • X.509 Certificates
        • Single Sign-On
          • SCIM Provisioning
      • Backups
      • ArangoGraph API
        • Get started with the API
        • Get started with Oasisctl
      • Oasisctl
        • Options
        • Accept
          • Accept Organization
          • Accept Organization Invite
        • Add
          • Add Audit Log
          • Add Audit Log Destination
          • Add Group
          • Add Group Members
        • Audit Log
          • Audit Log Attach
          • Audit Log Detach
          • Audit Log Get
          • Audit Log Get Attached
          • Audit Log Get Attached Project
        • Backup
          • Backup Copy
          • Backup Download
        • Clone
          • Clone Deployment
          • Clone Deployment Backup
        • Completion
        • Create
          • Create API Key
          • Create Audit Log
          • Create Backup
          • Create Backup Policy
          • Create CA Certificate
          • Create Deployment
          • Create Example
          • Create Example Installation
          • Create Group
          • Create IP Allowlist
          • Create Metrics
          • Create Metrics Token
          • Create Notebook
          • Create Organization
          • Create Organization Invite
          • Create Private
          • Create Private Endpoint
          • Create Private Endpoint Service
          • Create Project
          • Create Role
        • Delete
          • Delete API Key
          • Delete Audit Log
          • Delete Audit Log Archive
          • Delete Audit Log Archive Events
          • Delete Audit Log Destination
          • Delete Backup
          • Delete Backup Policy
          • Delete CA Certificate
          • Delete Deployment
          • Delete Example
          • Delete Example Installation
          • Delete Group
          • Delete Group Members
          • Delete IP Allowlist
          • Delete Metrics
          • Delete Metrics Token
          • Delete Notebook
          • Delete Organization
          • Delete Organization Invite
          • Delete Organization Members
          • Delete Project
          • Delete Role
        • Disable
          • Disable Scheduled-Root-Password-Rotation
        • Enable
          • Enable Scheduled-Root-Password-Rotation
        • Generate Documentation
        • Get
          • Get Audit Log
          • Get Audit Log Archive
          • Get Audit Log Events
          • Get Backup
          • Get Backup Policy
          • Get CA Certificate
          • Get Deployment
          • Get Example
          • Get Example Installation
          • Get Group
          • Get IP Allowlist
          • Get Metrics
          • Get Metrics Token
          • Get Notebook
          • Get Organization
          • Get Organization Authentication
          • Get Organization Authentication Providers
          • Get Organization Email
          • Get Organization Email Domain
          • Get Organization Email Domain Restrictions
          • Get Organization Invite
          • Get Policy
          • Get Private
          • Get Private Endpoint
          • Get Private Endpoint Service
          • Get Project
          • Get Provider
          • Get Region
          • Get Role
          • Get Self
          • Get Server
          • Get Server Status
          • Get Terms & Conditions
        • Import
        • List
          • List API Keys
          • List ArangoDB
          • List ArangoDB Versions
          • List Audit Log
          • List Audit Log Archives
          • List Audit Log Destinations
          • List Audit Logs
          • List Backup
          • List Backup Policies
          • List Backups
          • List CA Certificates
          • List CPU Sizes
          • List Deployments
          • List Disk Performances
          • List Effective
          • List Effective Permissions
          • List Example
          • List Example Installations
          • List Examples
          • List Group
          • List Group Members
          • List Groups
          • List IP Allowlists
          • List Metrics
          • List Metrics Tokens
          • List Node Sizes
          • List Notebook Models
          • List Notebooks
          • List Organization
          • List Organization Invites
          • List Organization Members
          • List Organizations
          • List Permissions
          • List Projects
          • List Providers
          • List Regions
          • List Roles
          • List Servers
        • Lock
          • Lock CA Certificate
          • Lock Deployment
          • Lock IP Allowlist
          • Lock Organization
          • Lock Policy
          • Lock Project
        • Login
        • Logs
        • Pause
          • Pause Notebook
        • Rebalance
          • Rebalance Deployment
          • Rebalance Deployment Shards
        • Reject
          • Reject Organization
          • Reject Organization Invite
        • Renew
          • Renew API Key
          • Renew API Key Token
        • Resume
          • Resume Deployment
          • Resume Notebook
        • Revoke
          • Revoke API Key
          • Revoke API Key Token
          • Revoke Metrics
          • Revoke Metrics Token
        • Rotate
          • Rotate Deployment
          • Rotate Deployment Server
        • Top
        • Unlock
          • Unlock CA Certificate
          • Unlock Deployment
          • Unlock IP Allowlist
          • Unlock Organization
          • Unlock Policy
          • Unlock Project
        • Update
          • Update Audit Log
          • Update Backup
          • Update Backup Policy
          • Update CA Certificate
          • Update Deployment
          • Update Group
          • Update IP Allowlist
          • Update Metrics
          • Update Metrics Token
          • Update Notebook
          • Update Organization
          • Update Organization Authentication
          • Update Organization Authentication Providers
          • Update Organization Email
          • Update Organization Email Domain
          • Update Organization Email Domain Restrictions
          • Update Policy
          • Update Policy Add
          • Update Policy Add Binding
          • Update Policy Delete
          • Update Policy Delete Binding
          • Update Private
          • Update Private Endpoint
          • Update Private Endpoint Service
          • Update Project
          • Update Role
        • Upgrade
        • Version
        • Wait
          • Wait Deployment
    • AQL
      • How to invoke AQL
        • with arangosh
        • with the Web Interface
      • Fundamentals
        • Syntax
        • Data types
        • Bind Parameters
        • Type and value order
        • Accessing data from collections
        • Subqueries
        • Query Results
        • Query Errors
        • Limitations
      • Operators
      • Data Queries
      • High-level Operations
        • FOR
        • RETURN
        • FILTER
        • SEARCH
        • SORT
        • LIMIT
        • LET
        • COLLECT
        • WINDOW
        • REMOVE
        • UPDATE
        • REPLACE
        • INSERT
        • UPSERT
        • WITH
      • Functions
        • ArangoSearch
        • Array
        • Bit
        • Date
        • Document / Object
        • Fulltext
        • Geo
        • Miscellaneous
        • Numeric
        • String
        • Type check & cast
      • Graphs
        • Traversals explained
        • Traversals
        • Shortest Path
        • All Shortest Paths
        • k Shortest Paths
        • k Paths
      • Examples & Query Patterns
        • Create Test Data
        • Counting
        • Dynamic Attribute Names
        • Projections and filters
        • Joins
        • Grouping
        • Actors & Movies Dataset Queries
        • Traversals
        • Remove vertex
        • Queries without collections
        • Diffing Two Documents
        • Upsert / Repsert Guide
      • User-defined Functions
      • Execution and Performance
        • Query statistics
        • Parsing queries
        • Explaining queries
        • Query Profiling
        • Query Optimization
        • Caching query plans
        • Caching query results
        • Query logging
      • Common Errors
    • Graphs
      • General Graphs
        • Management
        • Functions
      • SatelliteGraphs
        • Management
        • Details
      • SmartGraphs
        • Getting Started
        • Management
        • Testing Graphs on Single Server
      • EnterpriseGraphs
        • Getting Started
        • Management
      • Working with Edges
      • Example graphs
    • Data Science
      • Graph Analytics
      • ArangoGraphML
        • Deploy
        • Getting Started
      • ArangoGraph Notebooks
      • Large Language Models and Knowledge Graphs
      • Adapters
        • NetworkX
        • cuGraph
        • PyG
        • DGL
        • RDF
    • Index and Search
      • Indexing
        • Index Basics
        • Which index to use when
        • Index Utilization
        • Working with Indexes
          • Persistent Indexes
          • Inverted Indexes
          • TTL Indexes
          • Fulltext Indexes
          • Multi-dimensional Indexes
          • Geo-spatial Indexes
          • Vertex-Centric Indexes
      • ArangoSearch
        • Example Datasets
        • Exact value matching
        • Range Queries
        • Prefix matching
        • Case-sensitivity and Diacritics
        • Wildcard search
        • Full-text token search
        • Phrase and proximity search
        • Faceted search
        • Fuzzy search
        • Geospatial search
        • Search highlighting
        • Nested search
        • Ranking
        • Performance
        • search-alias Views Reference
        • arangosearch Views Reference
      • Analyzers
    • Components
      • ArangoDB Server
        • Options
        • Environment variables
        • Storage Engine
      • Web Interface
        • Dashboard
        • Cluster
        • Collections
        • Document
        • Queries
        • Graphs
        • Services
        • Users
        • Logs
      • Tools
        • ArangoDB Shell
          • Examples
          • Details
          • Options
        • ArangoDB Starter
          • Options
          • Security
          • Architecture
        • arangodump
          • Examples
          • Options
          • Maskings
          • Limitations
        • arangorestore
          • Examples
          • Options
        • arangobackup
          • Examples
          • Options
        • arangoimport
          • Examples JSON
          • Examples CSV
          • Details
          • Options
        • arangoexport
          • Examples
          • Options
        • arangobench
          • Options
        • arangovpack
          • Options
        • arangoinspect
          • Examples
          • Options
        • Foxx CLI
          • Details
        • ArangoDB Datasets
    • Deploy
      • Single instance
        • Manual Start
        • Using the ArangoDB Starter
      • Cluster
        • Deployment
          • Manual Start
          • Using the ArangoDB Starter
        • Administration
        • Limitations
      • OneShard
      • Kubernetes
      • In the Cloud
      • Single instance vs. Cluster
      • Production Checklist
      • Architecture
        • Scalability
        • Data Sharding
        • Replication
    • Operations
      • Installation
        • Docker
        • Linux
          • Operating System Configuration
          • Linux OS Tuning Script Examples
        • Uninstallation
      • Backup & Restore
      • Upgrading
        • Community to Enterprise Edition
        • Starter Deployments
        • Manual Deployments
          • Single server
          • Cluster
        • Downgrading
      • Administration
        • Configuration
        • Telemetrics
        • Log Levels
        • License Management
        • Import & Export
        • User Management
          • In arangosh
        • ArangoDB Starter Administration
          • Removal Procedure
          • Recovery Procedure
        • Reduce Memory Footprint
      • Security
        • Security Options
        • Change Root Password
        • Encryption at Rest
        • Audit logging
        • Securing Starter Deployments
      • Troubleshooting
        • Query debug packages
        • arangod
        • Emergency Console
        • Cluster
          • Agency Dump
    • Develop
      • Operational Factors
      • SatelliteCollections
      • SmartJoins
      • Transactions
        • JavaScript Transactions
        • Stream Transactions
        • Locking and isolation
        • Durability
        • Limitations
      • Foxx Microservices
        • Getting started
        • Guides
          • Working with routers
          • Working with collections
          • Writing queries
          • Development mode
          • Testing Foxx services
          • Foxx in a cluster
          • Scripts and scheduling
          • Using Node modules
          • Using Webpack with Foxx
          • Authentication and sessions
          • Linking services together
          • Working with files
          • Making requests
          • Access from the browser
        • Deployment
        • Reference
          • Service manifest
          • Service context
          • Configuration
          • Routers
            • Endpoints
            • Middleware
            • Request
            • Response
          • Sessions middleware
            • Session storages
              • Collection storage
              • JWT storage
            • Session transports
              • Cookie transport
              • Header transport
          • Related modules
            • Authentication
            • OAuth 1.0a
            • OAuth 2.0
            • GraphQL
            • Queues
      • JavaScript API
        • @arangodb
          • db object
          • collection object
          • view object
          • cursor object
        • @arangodb/actions
        • @arangodb/analyzers
        • @arangodb/aql/queries
        • @arangodb/crypto
        • @arangodb/request
        • @arangodb/tasks
        • console
        • fs
      • HTTP API
        • General request handling
        • Authentication
        • Users
        • Databases
        • Collections
        • Documents
        • Graphs
          • Named graphs
          • Edges
        • Queries
          • AQL queries
          • AQL query plan cache
          • AQL query results cache
          • User-defined AQL functions
        • Transactions
          • Stream Transactions
          • JavaScript Transactions
        • Indexes
          • Persistent
          • Inverted
          • TTL
          • Multi-dimensional
          • Geo-Spatial
          • Fulltext
        • Views
          • search-alias Views
          • arangosearch Views
        • Analyzers
        • Import
        • Foxx
        • Jobs
        • Tasks
        • Replication
          • Replication Dump
          • Replication Logger
          • Replication Applier
          • Other Replication Commands
          • Write-Ahead Log
        • Monitoring
          • Logs
          • Statistics
          • Metrics
        • Security
        • Administration
        • Cluster
        • Hot Backups
      • Error codes and meanings
      • Drivers
        • Java driver
          • Reference version 7
            • Driver Setup
            • Serialization
            • Changes in version 7
        • Go driver
        • Node.js driver
        • Python driver
      • Integrations
        • Spring Data
          • Reference version 4
            • Template
            • Repositories
              • Queries
                • Derived queries
                • Query methods
                • Named queries
            • Mapping
              • Document
              • Edge
              • Reference
              • Relations
              • Indexes
              • Computed Values
              • Converter
              • Events
              • Auditing
          • Migration
        • Spring Boot Starter
        • Datasource for Apache Spark
        • Kafka Connector
          • Configuration
    • Release Notes
      • Version 3.13
        • What’s New in 3.13
        • Known Issues in 3.13
        • Incompatible changes in 3.13
        • API changes in 3.13
      • Version 3.12
        • What’s New in 3.12
        • Known Issues in 3.12
        • Incompatible changes in 3.12
        • API changes in 3.12
      • Version 3.11
        • What’s New in 3.11
        • Known Issues in 3.11
        • Incompatible changes in 3.11
        • API changes in 3.11
      • Version 3.10
        • What’s New in 3.10
        • Known Issues in 3.10
        • Incompatible changes in 3.10
        • API changes in 3.10
      • Version 3.9
        • What’s New in 3.9
        • Known Issues in 3.9
        • Incompatible changes in 3.9
        • API changes in 3.9
      • Version 3.8
        • What’s New in 3.8
        • Known Issues in 3.8
        • Incompatible changes in 3.8
        • API changes in 3.8
      • Version 3.7
        • What’s New in 3.7
        • Known Issues in 3.7
        • Incompatible changes in 3.7
        • API changes in 3.7
      • Version 3.6
        • What’s New in 3.6
        • Known Issues in 3.6
        • Incompatible changes in 3.6
      • Version 3.5
        • What’s New in 3.5
        • Known Issues in 3.5
        • Incompatible changes in 3.5
      • Version 3.4
        • What’s New in 3.4
        • Known Issues in 3.4
        • Incompatible changes in 3.4
      • Version 3.3
        • What’s New in 3.3
        • Known Issues in 3.3
        • Incompatible changes in 3.3
      • Version 3.2
        • What’s New in 3.2
        • Known Issues in 3.2
        • Incompatible changes in 3.2
      • Version 3.1
        • What’s New in 3.1
        • Incompatible changes in 3.1
      • Version 3.0
        • What’s New in 3.0
        • Incompatible changes in 3.0
      • Deprecated and removed features
  1. 3.11.13
  2. Components
  3. Tools
  4. arangoinspect

arangoinspect

arangoinspect is a command-line client tool that collects information of any ArangoDB server setup to facilitate troubleshooting for the ArangoDB support

Examples

How to use the arangoinspect tool to collection information for troubleshooting

Options

The startup options of the arangoinspect executable

arangovpack

Examples