Skip to content

README.md

Latest commit

 

History

History
79 lines (53 loc) · 2.72 KB

README.md

File metadata and controls

79 lines (53 loc) · 2.72 KB

Couchbase.Aspire.Hosting library

Provides extension methods and resource definitions for an Aspire AppHost to configure a Couchbase cluster resource.

Getting Started

Install the package

dotnet add package Couchbase.Aspire.Hosting

Usage example

In the AppHost.cs file of your AppHost, add a Couchbase cluster resource with the data, query, and index services and consume the connection using the following methods:

var couchbase = builder.AddCouchbase("couchbase");
var bucket = couchbase.AddBucket("mybucket");

var myService = builder.AddProject<Projects.MyService>()
    .WithReference(bucket)
    .WaitFor(bucket);

Multi-dimensional scaling example

It is also possible to run a multiple server cluster with various services assigned to different server groups:

var couchbase = builder.AddCouchbase("couchbase");
var bucket1 = couchbase.AddBucket("bucket1");

var group1 = couchbase.AddServerGroup("couchbase-group1")
    .WithServices(CouchbaseServices.Data)
    .WithReplicas(2);

var group2 = couchbase.AddServerGroup("couchbase-group2")
    .WithServices(CouchbaseServices.Index | CouchbaseServices.Query)
    .WithReplicas(2);

var myService = builder.AddProject<Projects.MyService>()
    .WithReference(bucket)
    .WaitFor(bucket);

Connection properties

When you reference a Couchbase cluster resource using WithReference, the following connection properties are made available to the consuming project:

Couchbase cluster

The Couchbase cluster resource exposes the following connection properties:

Property Name Description
Username The username for authentication
Password The password for authentication
Uri The connection URI, with the format couchbase://{Host}:{Port},{Host2}:{Port} or couchbases://{Host}:{Port},{Host2}:{Port}

The ConnectionString property is also available, which exposes all properties as a single string in the format couchbase://{Username}:{Password}@{Host}:{Port},{Host2}:{Port}.

Couchbase bucket

The Couchbase bucket resource exposes the following connection properties:

Property Name Description
Username The username for authentication
Password The password for authentication
Uri The connection URI, with the format couchbase://{Host}:{Port},{Host2}:{Port} or couchbases://{Host}:{Port},{Host2}:{Port}
BucketName The name of the bucket

The ConnectionString property is also available, which exposes all properties as a single string in the format couchbase://{Username}:{Password}@{Host}:{Port},{Host2}:{Port}/{BucketName}.

Feedback & contributing

https://github.com/couchbaselabs/couchbase-aspire