CouchDB.NET

LINQ queries

// SetuppublicclassMyDeathStarContext:CouchContext{publicCouchDatabase<Rebel>Rebels{get;set;}publicCouchDatabase<Clone>Clones{get;set;}protectedoverridevoidOnConfiguring(CouchOptionsBuilderoptionsBuilder){optionsBuilder.UseEndpoint("http://localhost:5984/").EnsureDatabaseExists().UseBasicAuthentication(username:"anakin",password:"empirerule");}}// Usageawaitusingvarcontext=newMyDeathStarContext();varskywalkers=awaitcontext.Rebels.Where(r=>r.Surname=="Skywalker"&&(r.Battles.All(b=>b.Planet=="Naboo")||r.Battles.Any(b=>b.Planet=="Death Star"))).OrderByDescending(r=>r.Name).ThenByDescending(r=>r.Age).Take(2).Select(        r=>r.Name,        r=>r.Age}).ToListAsync();

{"selector": {"$and": [      {"surname":"Skywalker"      },      {"$or": [          {"battles": {"$allMatch": {"planet":"Naboo"              }            }          },          {"battles": {"$elemMatch": {"planet":"Death Star"              }            }          }        ]      }    ]  },"sort": [    {"name":"desc" },    {"age":"desc" }  ],"limit":2,"fields": ["name","age"  ]}

Index

Getting started

Queries

varskywalkers=fromrincontext.Rebelswherer.Surname=="Skywalker"selectr;

Selector

Combinations

Conditions

Native methods

Composite methods

All other IQueryables methods

Client operations

// CRUD from class name (rebels)varrebels=client.GetDatabase<Rebel>();varrebels=awaitclient.GetOrCreateDatabaseAsync<Rebel>();varrebels=awaitclient.CreateDatabaseAsync<Rebel>();awaitclient.DeleteDatabaseAsync<Rebel>();// CRUD specific namevarrebels=client.GetDatabase<Rebel>("naboo_rebels");varrebels=client.GetOrCreateDatabaseAsync<Rebel>("naboo_rebels");varrebels=awaitclient.CreateDatabaseAsync<Rebel>("naboo_rebels");awaitclient.DeleteDatabaseAsync("naboo_rebels");// UtilsvarisRunning=awaitclient.IsUpAsync();vardatabases=awaitclient.GetDatabasesNamesAsync();vartasks=awaitclient.GetActiveTasksAsync();

Database operations

// CRUDawaitrebels.AddAsync(rebel);awaitrebels.AddOrUpdateAsync(rebel);awaitrebels.RemoveAsync(rebel);varrebel=awaitrebels.FindAsync(id);varrebel=awaitrebels.FindAsync(id,withConflicts:true);varlist=awaitrebels.FindManyAsync(ids);varlist=awaitrebels.QueryAsync(someMangoJson);varlist=awaitrebels.QueryAsync(someMangoObject);// Bulkawaitrebels.AddOrUpdateRangeAsync(moreRebels);awaitrebels.DeleteRangeAsync(ids);awaitrebels.DeleteRangeAsync(moreRebels);// Utilsawaitrebels.CompactAsync();varinfo=awaitrebels.GetInfoAsync();// Securityawaitrebels.Security.SetInfoAsync(securityInfo);varsecurityInfo=awaitrebels.Security.GetInfoAsync();

Authentication

// Basic.UseBasicAuthentication("root","relax")// Cookie.UseCookieAuthentication("root","relax").UseCookieAuthentication("root","relax",cookieDuration)// Proxy.UseProxyAuthentication("root",new[]{"role1","role2"})// JTW.UseJwtAuthentication("token").UseJwtAuthentication(async()=>awaitNewTokenAsync())

Options

publicclassMyDeathStarContext:CouchContext{/* ... */protectedoverridevoidOnConfiguring(CouchOptionsBuilderoptionsBuilder){optionsBuilder.UseBasicAuthentication("root","relax").DisableEntitisPluralization()        ...}}// orvarclient=newCouchClient("http://localhost:5984", builder=>builder.UseBasicAuthentication("root","relax").DisableEntitisPluralization()    ...)

Custom JSON values

[JsonObject("custom-rebels")]publicclassOtherRebel:Rebel[JsonProperty("rebel_bith_date")]public DateTime BirthDate{get;set;}

Attachments

// Get a documentvarluke=newRebel{Name="Luke",Age=19};// Add in memoryvarpathToDocument=@".\luke.txt"luke.Attachments.AddOrUpdate(pathToDocument,MediaTypeNames.Text.Plain);// Delete in memoryluke.Attachments.Delete("yoda.txt");// Saveluke=awaitrebels.CreateOrUpdateAsync(luke);// GetCouchAttachmentlukeTxt=luke.Attachments["luke.txt"];// Iterateforeach(CouchAttachmentattachmentinluke.Attachments){   ...}// DownloadstringdownloadFilePath=awaitrebels.DownloadAttachment(attachment,downloadFolderPath,"luke-downloaded.txt");//orStreamresponseStream=awaitrebels.DownloadAttachmentAsStreamAsync(attachment);

Revisions

await_rebels.FindAsync("1",newFindOptions{Rev="1-xxx"});await_rebels.AddOrUpdateAsync(r,newAddOrUpdateOptions{Rev="1-xxx"});

DB Changes Feed

vartokenSource=newCancellationTokenSource();awaitforeach(varchangein_rebels.GetContinuousChangesAsync(options:null,filter:null,tokenSource.Token)){if(/* ... */){tokenSource.Cancel();}}

Feed Options

// Examplevaroptions=newChangesFeedOptions{Descending=true,Limit=10,Since="now",IncludeDocs=true};ChangesFeedResponse<Rebel>changes=awaitGetChangesAsync(options);

Feed Filter

// _doc_idsvarfilter=ChangesFeedFilter.DocumentIds(new[]{"luke","leia"});// _selectorvarfilter=ChangesFeedFilter.Selector<Rebel>(rebel=>rebel.Age==19);// _designvarfilter=ChangesFeedFilter.Design();// _viewvarfilter=ChangesFeedFilter.View(view);// UseChangesFeedResponse<Rebel>changes=awaitGetChangesAsync(options:null,filter);

Indexing

// Basic index creationawait_rebels.CreateIndexAsync("rebels_index", b=>b.IndexBy(r=>r.Surname)).ThenBy(r=>r.Name));// Descending index creationawait_rebels.CreateIndexAsync("rebels_index", b=>b.IndexByDescending(r=>r.Surname)).ThenByDescending(r=>r.Name));

Index Options

// Specifies the design document and/or whether a JSON index is partitioned or globalawait_rebels.CreateIndexAsync("rebels_index", b=>b.IndexBy(r=>r.Surname),newIndexOptions(){DesignDocument="surnames_ddoc",Partitioned=true});

Partial Indexes

// Create an index which excludes documents at index timeawait_rebels.CreateIndexAsync("skywalkers_index", b=>b.IndexBy(r=>r.Name).Where(r=>r.Surname=="Skywalker");

Indexes operations

// Get the list of indexesvarindexes=await_rebels.GetIndexesAsync();// Delete an indexesawait_rebels.DeleteIndexAsync(indexes[0]);// orawait_rebels.DeleteIndexAsync("surnames_ddoc",name:"surnames");

CouchContext Index Configuration

publicclassMyDeathStarContext:CouchContext{publicCouchDatabase<Rebel>Rebels{get;set;}// OnConfiguring(CouchOptionsBuilder optionsBuilder) { ... }protectedoverridevoidOnDatabaseCreating(CouchDatabaseBuilderdatabaseBuilder){databaseBuilder.Document<Rebel>().HasIndex("rebel_surnames_index", b=>b.IndexBy(b=>b.Surname));}}

Database Splitting

publicclassMyDeathStarContext:CouchContext{publicCouchDatabase<Rebel>Rebels{get;set;}publicCouchDatabase<Vehicle>Vehicles{get;set;}// OnConfiguring(CouchOptionsBuilder optionsBuilder) { ... }protectedoverridevoidOnDatabaseCreating(CouchDatabaseBuilderdatabaseBuilder){databaseBuilder.Document<Rebel>().ToDatabase("troops");databaseBuilder.Document<Vehicle>().ToDatabase("troops");}}

varrebels=client.GetDatabase<Rebel>("troops",nameof(Rebel));varvehicles=client.GetDatabase<Vehicle>("troops",nameof(Vehicle));

Views

varoptions=newCouchViewOptions<string[]>{StartKey=new[]{"Luke","Skywalker"},IncludeDocs=true};varviewRows=await_rebels.GetViewAsync<string[],RebelView>("jedi","by_name",options);// ORvardetails=await_rebels.GetDetailedViewAsync<int,BattleView>("battle","by_name",options);

varlukeOptions=newCouchViewOptions<string[]>{Key=new[]{"Luke","Skywalker"},IncludeDocs=true};varyodaOptions=newCouchViewOptions<string[]>{Key=new[]{"Yoda"},IncludeDocs=true};varqueries=new[]{lukeOptions,yodaOptions};varresults=await_rebels.GetViewQueryAsync<string[],RebelView>("jedi","by_name",queries);varlukeRows=results[0];varyodaRows=results[1];// ORvardetails=await_rebels.GetDetailedViewQueryAsync<string[],RebelView>("jedi","by_name",queries);varlukeDetails=details[0];varyodaDetails=details[1];

Local (non-replicating) Documents

vardocId="settings";varsettings=newRebelSettings{Id=docId,IsActive=true};// Createawait_rebels.LocalDocuments.CreateOrUpdateAsync(settings);// Get by IDsettings=await_rebels.LocalDocuments.GetAsync<RebelSettings>(docId);// Get allvardocs=awaitlocal.GetAsync();// SearchvarsearchOpt=newLocalDocumentsOptions{Descending=true,Limit=10,Conflicts=true};vardocs=awaitlocal.GetAsync(searchOpt);

Bookmark and Execution stats

varallRebels=awaitrebels.ToCouchListAsync();foreach(varrinallRebels){    ...}varb=allRebels.Bookmark;varex=allRebels.ExecutionStats;// .IncludeExecutionStats() must be called

Users

varusers=client.GetUsersDatabase();varluke=awaitusers.CreateAsync(newCouchUser(name:"luke",password:"lasersword"));

varusers=client.GetUsersDatabase<CustomUser>();varluke=awaitusers.CreateAsync(newCustomUser(name:"luke",password:"lasersword"));

luke=awaitusers.ChangeUserPassword(luke,"r2d2");

Replication

if(awaitclient.ReplicateAsync("anakin","jedi",newCouchReplication(){Continuous=true})){awaitclient.RemoveReplicationAsync("anakin","jedi",newCouchReplication(){Continuous=true});}

awaitclient.ReplicateAsync("stormtroopers","deathstar",newCouchReplication(){Continuous=true,Selector=new{designation="FN-2187"}}));

awaitclient.ReplicateAsync("luke","jedi",newCouchReplication(){SourceCredentials=newCouchReplicationBasicCredentials()username:"luke",password:"r2d2")}));

Dependency Injection

publicclassMyDeathStarContext:CouchContext{publicCouchDatabase<Rebel>Rebels{get;set;}publicMyDeathStarContext(CouchOptions<MyDeathStarContext>options):base(options){}}

// RebelsControllerpublicclassRebelsController:Controller{privatereadonlyMyDeathStarContext_context;publicRebelsController(MyDeathStarContextcontext){_context=context;}}

Microsoft container

// ConfigureServicesservices.AddCouchContext<MyDeathStarContext>(builder=>builder.UseEndpoint("http://localhost:5984").UseBasicAuthentication(username:"admin",password:"admin"));

Autofac container

// ConfigureServicesvarcontainerBuilder=newContainerBuilder();containerBuilder.AddCouchContext<MyDeathStarContext>(optionsBuilder=>optionsBuilder.UseEndpoint("http://localhost:5984").UseBasicAuthentication(username:"admin",password:"admin"));

Advanced

protectedvirtualTaskOnBeforeCallAsync(HttpCallcall)

Contributors