• Introduction
  • Highlights
  • GETTING FAMILIAR
  • Getting Started
    • Installation
    • Authentication
    • Web Interface
    • Databases, Collections and Documents
    • Querying the Database
    • Coming from SQL
    • Next Steps
  • Tutorials
    • ArangoDB Starter
    • Datacenter to datacenter Replication
    • Kubernetes
    • Datacenter to datacenter Replication on Kubernetes
  • Programs & Tools
    • ArangoDB Server
      • Options
    • Web Interface
      • Dashboard
      • Cluster
      • Collections
      • Document
      • Queries
      • Graphs
      • Services
      • Users
      • Logs
    • ArangoDB Shell
      • Examples
      • Details
      • Options
    • ArangoDB Starter
      • Options
      • Security
      • Architecture
    • Arangodump
      • Examples
      • Options
    • Arangorestore
      • Examples
      • Options
    • Arangoimport
      • Examples JSON
      • Examples CSV
      • Details
      • Options
    • Arangoexport
      • Examples
      • Options
    • Arangobench
      • Examples
      • Options
    • Arangoinspect
      • Examples
      • Options
    • Datafile Debugger
      • Examples
    • Foxx CLI
      • Details
  • CORE TOPICS
  • Data models & modeling
    • Concepts
    • Databases
      • Working with Databases
      • Notes about Databases
    • Collections
      • Collection Methods
      • Database Methods
    • Documents
      • Basics and Terminology
      • Collection Methods
      • Database Methods
    • Graphs, Vertices & Edges
    • Views
      • Database Methods
      • View Methods
    • Naming Conventions
      • Database Names
      • Collection Names
      • Document Keys
      • Attribute Names
  • Indexing
    • Index Basics
    • Which index to use when
    • Index Utilization
    • Working with Indexes
      • Hash Indexes
      • Skiplists
      • Persistent
      • Fulltext Indexes
      • Geo-spatial Indexes
      • Vertex Centric Indexes
  • Transactions
    • Transaction invocation
    • Passing parameters
    • Locking and isolation
    • Durability
    • Limitations
  • Graphs
    • General Graphs
      • Graph Management
      • Graph Functions
    • SmartGraphs
      • SmartGraph Management
    • Traversals
      • Using Traversal Objects
      • Example Data
    • Working with Edges
    • Pregel
  • ArangoSearch Views
    • Analyzers
  • ADVANCED TOPICS
  • Architecture
    • Storage Engines
    • Replication
    • Write-ahead log
  • Foxx Microservices
    • Getting started
    • Reference
      • Service manifest
      • Service context
      • Configuration
      • Dependencies
      • Routers
        • Endpoints
        • Middleware
        • Request
        • Response
      • Using GraphQL
      • Sessions middleware
        • Session storages
          • Collection storage
          • JWT storage
        • Session transports
          • Cookie transport
          • Header transport
      • Serving files
      • Writing tests
      • Cross Origin
      • Scripts and queued jobs
      • Legacy compatibility mode
      • User management
      • Related modules
        • Authentication
        • OAuth 1.0a
        • OAuth 2.0
    • Deployment
    • Migrating 2.x services
      • Migrating from pre-2.8
      • manifest.json
      • applicationContext
      • Repositories and Models
      • Controllers
        • Request context
        • Error handling
        • Before/After/Around
        • Request object
        • Response object
        • Dependency Injection
      • Sessions
      • Auth and OAuth2
      • Foxx Queries
  • Scalability
    • Master/Slave
      • Architecture
      • Limitations
    • Active Failover
      • Architecture
      • Limitations
    • Cluster
      • Architecture
      • Data models
      • Limitations
    • Datacenter to datacenter replication
      • Introduction
      • Applicability
      • Requirements
      • Limitations
  • Satellite Collections
  • OPERATIONS
  • Installation
    • Linux
    • Mac OS X
    • Windows
    • Compiling
  • Deployment
    • By ArangoDB Deployment Modes
      • Single Instance
        • Using the ArangoDB Starter
        • Manual Start
      • Master/Slave
        • Manual Start
      • Active Failover
        • Using the ArangoDB Starter
        • Manual Start
      • Cluster
        • Preliminary Information
        • Using the ArangoDB Starter
        • Manual Start
        • Kubernetes
        • Mesos, DC/OS
      • Multiple Datacenters
        • Cluster
        • ArangoSync Master
        • ArangoSync Workers
        • Prometheus & Grafana
        • Kafka & Zookeeper
      • Standalone Agency
    • By Technology
      • Manually
      • ArangoDB Starter
      • Docker
      • Kubernetes
        • Using the Operator
        • Deployment Resource Reference
        • Driver Configuration
        • Authentication
        • Scaling
        • Upgrading
        • ArangoDB Configuration & Secrets
        • Metrics
        • Services & Load balancer
        • Deployment Replication Resource Reference
        • Storage
        • Storage Resource
        • TLS
        • Troubleshooting
      • Mesos, DC/OS
  • Upgrading
    • General Upgrade Information
    • OS-specific Information
      • Upgrading on Linux
    • Upgrading Starter Deployments
    • Upgrading Manual Deployments
      • Upgrading a Cluster
    • Version Specific Upgrade Information
      • Upgrading to 3.4
      • Upgrading to 3.3
      • Upgrading to 3.2
      • Upgrading to 3.1
      • Upgrading to 3.0
      • Upgrading to 2.8
      • Upgrading to 2.6
      • Upgrading to 2.5
      • Upgrading to 2.4
      • Upgrading to 2.3
      • Upgrading to 2.2
  • Administration
    • Backup & Restore
    • Import & Export
    • User Management
      • In Arangosh
    • Server Configuration
      • Operating System Configuration
      • Managing Endpoints
      • SSL Configuration
      • LDAP Options
      • Logging Options
      • General Options
      • Write-Ahead Log Options
      • Compaction Options
      • Cluster Options
      • RocksDB Engine Options
      • Hash Cache Options
      • Asynchronous Tasks
      • Durability
    • Master/Slave
      • Setting up
        • Replication Applier
        • Per-Database Setup
        • Server-Level Setup
      • Syncing Collections
    • Active Failover
    • Cluster
    • Datacenter to datacenter replication
  • Security
    • Change Root Password
    • Encryption
    • Auditing
      • Configuration
      • Events
    • Securing Starter Deployments
    • Datacenter to datacenter replication
  • Monitoring
    • Datacenter to datacenter replication
  • Troubleshooting
    • arangod
    • Emergency Console
    • Cluster
      • Agency Dump
    • Datacenter to datacenter replication
  • Release Notes
    • Version 3.4
      • What's New in 3.4
      • Incompatible changes in 3.4
    • Version 3.3
      • What's New 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
    • Version 2.8
      • What's New in 2.8
      • Incompatible changes in 2.8
    • Version 2.7
      • What's New in 2.7
      • Incompatible changes in 2.7
    • Version 2.6
      • What's New in 2.6
      • Incompatible changes in 2.6
    • Version 2.5
      • What's New in 2.5
      • Incompatible changes in 2.5
    • Version 2.4
      • What's New in 2.4
      • Incompatible changes in 2.4
    • Version 2.3
      • What's New in 2.3
      • Incompatible changes in 2.3
    • Version 2.2
      • What's New in 2.2
    • Version 2.1
      • What's New in 2.1
  • Appendix
    • References
      • db
      • collection
      • cursor
    • JavaScript Modules
      • @arangodb
      • console
      • crypto
      • fs
      • request
      • actions
      • queries
      • Write-ahead log
      • Task Management
    • Deprecated
      • Simple Queries
        • Pagination
        • Modification Queries
        • Geo Queries
        • Fulltext Queries
      • Actions
        • Delivering HTML Pages
        • Json Objects
        • Modifying
    • Error codes and meanings
    • Glossary
  • Published with GitBook

collection

The "collection" Object

The following methods exist on the collection object (returned by db.name):

Collection

  • collection.checksum()
  • collection.count()
  • collection.drop()
  • collection.figures()
  • collection.load()
  • collection.properties(options)
  • collection.revision()
  • collection.rotate()
  • collection.toArray()
  • collection.truncate()
  • collection.type()
  • collection.unload()

Indexes

  • collection.dropIndex(index)
  • collection.ensureIndex(description)
  • collection.getIndexes(name)
  • collection.index(index)

Document

  • collection.all()
  • collection.any()
  • collection.byExample(example)
  • collection.closedRange(attribute, left, right)
  • collection.document(object)
  • collection.documents(keys)
  • collection.edges(vertex-id)
  • collection.exists(object)
  • collection.firstExample(example)
  • collection.inEdges(vertex-id)
  • collection.insert(data)
  • collection.edges(vertices)
  • collection.iterate(iterator,options)
  • collection.outEdges(vertex-id)
  • collection.range(attribute, left, right)
  • collection.remove(selector)
  • collection.removeByExample(example)
  • collection.removeByKeys(keys)
  • collection.rename()
  • collection.replace(selector, data)
  • collection.replaceByExample(example, data)
  • collection.save(data)
  • collection.update(selector, data)
  • collection.updateByExample(example, data)


© ArangoDB - the native multi-model NoSQL database