Couchbase.Extensions.DnsDiscovery 2.0.2

The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org. Prefix Reserved
dotnet add package Couchbase.Extensions.DnsDiscovery --version 2.0.2
NuGet\Install-Package Couchbase.Extensions.DnsDiscovery -Version 2.0.2
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Couchbase.Extensions.DnsDiscovery" Version="2.0.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Couchbase.Extensions.DnsDiscovery --version 2.0.2
#r "nuget: Couchbase.Extensions.DnsDiscovery, 2.0.2"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Couchbase.Extensions.DnsDiscovery as a Cake Addin
#addin nuget:?package=Couchbase.Extensions.DnsDiscovery&version=2.0.2

// Install Couchbase.Extensions.DnsDiscovery as a Cake Tool
#tool nuget:?package=Couchbase.Extensions.DnsDiscovery&version=2.0.2

Couchbase.Extensions.DnsDiscovery

A .Net Core compatible DNS SRV mechanism for discovering a Couchbase cluster dynamically.

Getting Started

Assuming you have an installation of Couchbase Server and Visual Studio (examples with VSCODE forthcoming), do the following:

  • Create a .NET Core Web Application using Visual Studio or VsCodeor CIL
  • Install the package from NuGet or build from source and add reference

Configuration

To use, call AddCouchbaseDnsDiscovery during the service registration process, usually in your Startup class. You may choose whether or not to add this step based on the environment. Be sure to add the basic Couchbase configuration first.


public class Startup
{
    public Startup(IHostingEnvironment env)
    {
        var builder = new ConfigurationBuilder()
            .SetBasePath(env.ContentRootPath)
            .AddJsonFile("appsettings.json", optional: true, reloadOnChange: true)
            .AddJsonFile($"appsettings.{env.EnvironmentName}.json", optional: true)
            .AddEnvironmentVariables();

        Configuration = builder.Build();
        Environment = env;
    }

    public IConfigurationRoot Configuration { get; }
    public IHostingEnvironment Environment { get; }

    public void ConfigureServices(IServiceCollection services)
    {
        // Register Couchbase with configuration section
        services.AddCouchbase(Configuration.GetSection("Couchbase"));
        services.AddCouchbaseDnsDiscovery();

        // Register other services, like .AddMvc()
    }

Example configuration file:

{
    "Couchbase": {
        "Username": "Administrator",
        "Password": "Password",
        "ConnectionString": "couchbase://services.local"
    }
}

The above configuration will perform a DNS SRV query for _couchbase._tcp.services.local, based on the single entry in the Servers section of the configuration. The results will be used to replace the Servers list in the Couchbase client configuration.

The following rules will be applied:

  1. If using ConnectionString, there must be only one server listed in the string
  2. If using the Servers collection, there must be only one URI in the collection
  3. The URI must use either the "couchbase://" or "couchbases://" scheme
  4. The URI must not have a port number
  5. If these rules aren't matched, or if no DNS SRV records is found, then the client will fallback to directly connecting to the listed servers

Due to the nature of Couchbase clusters, the priority and weight fields in the DNS SRV records are ignored. However, the port is used and should normally be set to 11210 for _couchbase and 11207 for _couchbases.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
2.0.2 35,005 5/9/2018
2.0.1 5,656 3/1/2018
2.0.0 1,656 11/8/2017
1.0.2 4,703 8/7/2017
1.0.0 1,540 2/15/2017
1.0.0-beta4 879 1/26/2017
1.0.0-beta2 824 1/8/2017