CouchbaseGetCollection

Get a Couchbase collection instance for document operations.

Syntax

couchbaseGetCollection(cacheName, [scopeName], [collectionName])

Parameters

Parameter	Type	Required	Default	Description
cacheName	String	Yes	-	Name of the cache configuration
scopeName	String	No	_default	Name of the scope within the bucket
collectionName	String	No	_default	Name of the collection within the scope

Returns

Returns the Couchbase Collection instance with access to:

• Document CRUD operations (get, insert, upsert, replace, remove)

• Binary operations

• Subdocument operations

• Query execution

• Full-text search

Examples

Get Default Collection

// Get default collection (most common)
collection = couchbaseGetCollection("default");

// Perform document operations
collection.upsert("user:123", { name: "John", email: "[email protected]" });
doc = collection.get("user:123");

Get Custom Collection

// Get specific collection
usersCollection = couchbaseGetCollection("default", "myapp", "users");

// Insert user document
usersCollection.insert("user:456", {
    name: "Jane Doe",
    email: "[email protected]",
    role: "admin"
});

Multiple Collections

// Different collections for different data types
usersCol = couchbaseGetCollection("default", "myapp", "users");
ordersCol = couchbaseGetCollection("default", "myapp", "orders");
productsCol = couchbaseGetCollection("default", "myapp", "products");

// Operate on each independently
usersCol.upsert("user:1", { name: "John" });
ordersCol.upsert("order:1", { userId: "user:1", total: 99.99 });
productsCol.upsert("product:1", { name: "Widget", price: 9.99 });

Document Operations

collection = couchbaseGetCollection("default");

// Insert (fails if exists)
collection.insert("doc:1", { data: "new" });

// Upsert (insert or update)
collection.upsert("doc:2", { data: "updated" });

// Replace (fails if not exists)
collection.replace("doc:1", { data: "replaced" });

// Remove
collection.remove("doc:1");

// Get
result = collection.get("doc:2");
content = result.contentAsObject();

Subdocument Operations

collection = couchbaseGetCollection("default");

// Get specific field
result = collection.lookupIn("user:123")
    .get("email")
    .execute();
email = result.contentAs(0, "java.lang.String");

// Update specific field
collection.mutateIn("user:123")
    .upsert("lastLogin", now())
    .execute();

Binary Operations

collection = couchbaseGetCollection("default");

// Store binary data
collection.upsert("image:123", toBinary(imageData));

// Get binary data
result = collection.get("image:123");
binary = result.contentAs("byte[]");

Notes

• Default collection is _default in _default scope

• Collections provide document-level organization within scopes

• Collection names are case-sensitive

• Collection must exist in Couchbase or operation will fail

• Most cache operations use the default collection automatically

• Direct collection access is for advanced scenarios

Collection Benefits

• Document type isolation - Separate users, orders, products, etc.

• Schema flexibility - Different document structures per collection

• Index optimization - Create indexes specific to collection

• Access control - Grant permissions per collection

• Query performance - Queries run faster on smaller collections

Related Functions

• couchbaseGetBucket - Get bucket instance

• couchbaseGetScope - Get scope instance

• couchbaseQuery - Execute queries

See Also

• API Usage Guide

• Couchbase Collections

• Document Operations