Interface EdgeCollection<T>

example

const db = new Database();
const collection = db.collection("some-collection");
const data = await collection.checksum();
// data contains the collection's checksum

example

const db = new Database();
const collection = db.collection("some-collection");
const data = await collection.count();
// data contains the collection's count

See also Database.createCollection and Database.createEdgeCollection.

Note: When called on an EdgeCollection instance in TypeScript, the type option must still be set to the correct CollectionType. Otherwise this will result in the collection being created with the default type (i.e. as a document collection).

example

const db = new Database();
const collection = db.collection("potatoes");
await collection.create();
// the document collection "potatoes" now exists

example

const db = new Database();
const collection = db.collection("friends");
await collection.create({ type: CollectionType.EDGE_COLLECTION });
// the edge collection "friends" now exists

example

interface Friend {
  startDate: number;
  endDate?: number;
}
const db = new Database();
const collection = db.collection("friends") as EdgeCollection<Friend>;
// even in TypeScript you still need to indicate the collection type
// if you want to create an edge collection
await collection.create({ type: CollectionType.EDGE_COLLECTION });
// the edge collection "friends" now exists

Throws an exception when passed a document or _id from a different collection.

example

const db = new Database();
const collection = db.collection("some-collection");
const exists = await collection.documentExists("abc123");
if (!exists) {
  console.log("Document does not exist");
}

Throws an exception when passed a document or _id from a different collection.

example

const db = new Database();
const collection = db.collection("some-collection");
const meta = await collection.save({ foo: "bar" }, { returnNew: true });
const doc = meta.new;
console.log(collection.documentId(meta)); // via meta._id
console.log(collection.documentId(doc)); // via doc._id
console.log(collection.documentId(meta._key)); // also works

example

const db = new Database();
const collection1 = db.collection("some-collection");
const collection2 = db.collection("other-collection");
const meta = await collection1.save({ foo: "bar" });
// Mixing collections is usually a mistake
console.log(collection1.documentId(meta)); // ok: same collection
console.log(collection2.documentId(meta)); // throws: wrong collection
console.log(collection2.documentId(meta._id)); // also throws
console.log(collection2.documentId(meta._key)); // ok but wrong collection

example

const db = new Database();
const collection = db.collection("some-collection");
await collection.drop();
// The collection "some-collection" is now an ex-collection

example

// Create a unique index for looking up documents by username
await collection.ensureIndex({
  type: "persistent",
  fields: ["username"],
  name: "unique-usernames",
  unique: true
});

When using the RocksDB storage engine, hash indexes behave identically to persistent indexes.

example

// Create a unique index for looking up documents by username
await collection.ensureIndex({
  type: "hash",
  fields: ["username"],
  name: "unique-usernames",
  unique: true
});

When using the RocksDB storage engine, skiplist indexes behave identically to persistent indexes.

example

// Create an index for sorting email addresses
await collection.ensureIndex({
  type: "skiplist",
  fields: ["email"]
});

example

// Expire documents with "createdAt" timestamp one day after creation
await collection.ensureIndex({
  type: "ttl",
  fields: ["createdAt"],
  expireAfter: 60 * 60 * 24 // 24 hours
});

example

// Expire documents with "expiresAt" timestamp according to their value
await collection.ensureIndex({
  type: "ttl",
  fields: ["expiresAt"],
  expireAfter: 0 // when attribute value is exceeded
});

example

// Create a fulltext index for tokens longer than or equal to 3 characters
await collection.ensureIndex({
  type: "fulltext",
  fields: ["description"],
  minLength: 3
});

example

// Create an index for GeoJSON data
await collection.ensureIndex({
  type: "geo",
  fields: ["lngLat"],
  geoJson: true
});

example

const db = new Database();
const collection = db.collection("some-collection");
const result = await collection.exists();
// result indicates whether the collection exists

example

const db = new Database();
const collection = db.collection("some-collection");
const data = await collection.figures();
// data contains the collection's figures

example

const db = new Database();
const collection = db.collection("some-collection");
const data = await collection.get();
// data contains general information about the collection

deprecated

Simple Queries have been deprecated in ArangoDB 3.4 and can be replaced with AQL queries.

example

const db = new Database();
const collection = db.collection("some-collection");
await collection.load();
// the collection has now been loaded into memory

example

const db = new Database();
const collection = db.collection("some-collection");
await collection.load(false);
// the collection has now been loaded into memory

example

const db = new Database();
const collection = db.collection("indexed-collection");
await collection.loadIndexes();
// the indexes are now loaded into memory

example

const db = new Database();
const collection = db.collection("some-collection");
const data = await collection.properties();
// data contains the collection's properties

example

const db = new Database();
const collection = db.collection("some-collection");
const result = await collection.setProperties({ waitForSync: true });
// the collection will now wait for data being written to disk
// whenever a document is changed

example

const db = new Database();
const collection = db.collection("inconsistent-collection");
const badData = await collection.count();
// oh no, the collection count looks wrong -- fix it!
await collection.recalculateCount();
const goodData = await collection.count();
// goodData contains the collection's improved count

deprecated

Simple Queries have been deprecated in ArangoDB 3.4 and can be replaced with AQL queries.

deprecated

Simple Queries have been deprecated in ArangoDB 3.4 and can be replaced with AQL queries.

Additionally removes the instance from the Database's internal cache.

Note: Renaming collections may not be supported when ArangoDB is running in a cluster configuration.

example

const db = new Database();
const collection1 = db.collection("some-collection");
await collection1.rename("other-collection");
const collection2 = db.collection("some-collection");
const collection3 = db.collection("other-collection");
// Note all three collection instances are different objects but
// collection1 and collection3 represent the same ArangoDB collection!

deprecated

Simple Queries have been deprecated in ArangoDB 3.4 and can be replaced with AQL queries.

example

const db = new Database();
const collection = db.collection("some-collection");
const data = await collection.revision();
// data contains the collection's revision

example

const db = new Database();
const collection = db.collection("some-collection");
const rotated = await collection.rotate();

example

const db = new Database();
const collection = db.collection("some-collection");
await collection.truncate();
// millions of documents cry out in terror and are suddenly silenced,
// the collection "some-collection" is now empty

example

const db = new Database();
const collection = db.collection("some-collection");
await collection.unload();
// the collection has now been unloaded from memory

deprecated

Simple Queries have been deprecated in ArangoDB 3.4 and can be replaced with AQL queries.