{"id":2733,"date":"2017-02-16T16:38:16","date_gmt":"2017-02-17T00:38:16","guid":{"rendered":"https:\/\/www.couchbase.com\/blog\/?p=2733"},"modified":"2025-06-13T17:23:33","modified_gmt":"2025-06-14T00:23:33","slug":"introducing-couchbase-net-2-4-0-net-core-ga","status":"publish","type":"post","link":"https:\/\/www.couchbase.com\/blog\/introducing-couchbase-net-2-4-0-net-core-ga\/","title":{"rendered":"Introducing Couchbase .NET 2.4.0 – .NET Core GA"},"content":{"rendered":"

This release is the official GA release for .NET Core support for the Couchbase .NET SDK! .NET Core is the latest incarnation of the .NET framework and its described as\u00a0“.NET Core is a blazing fast, lightweight and modular platform for creating web applications and services that run on Windows, Linux and Mac”<\/em><\/p>\n

Wait a minute…read that again:\u00a0“.NET Core is a blazing fast, lightweight and modular platform for creating web applications and services that\u00a0<\/em>run on Windows, Linux and Mac<\/strong>“<\/em>. Microsoft .NET applications running on OSX and Linux? What kind of bizzaro world are we living in? It\u2019s the “New” Microsoft for sure!<\/p>\n

In this blog post, I’ll go over what is in the 2.4.0 release, changes to packaging (NuGet), and what version of .NET the SDK supports. We\u2019ll also demonstrate some of the new features such as Datastructures.<\/p>\n

What’s in this release?<\/strong><\/p>\n

2.4.0 is a large release with over 30 commits. When you consider that we released 3 Developer Previews leading up to 2.4.0, there are actually many, many more commits leading up to this release over the last 6 months. Here is an overview of some of the more impressive features – you can see all of the commits in the “Release Notes” section below:<\/p>\n

.NET Core Support<\/strong><\/p>\n

Of course the most significant feature of 2.4.0 is .NET Core support, which from the opening paragraph, means you can now develop on Mac OS or Windows and deploy to Linux (or vice-versa, but the tooling is a bit immature still). This is great stuff and a major change for the traditional Windows developer.<\/p>\n

If you\u2019re unaware of .NET Core, you can read up more about it over on the\u00a0.NET Core website<\/a>. One cool thing about it is that it\u2019s open source (Apache 2.0) and source is all available on Github.<\/p>\n

The Couchbase SDK specifically supports the\u00a0netstandard1.5\u00a0or greater. We tested the SDK using\u00a01.0.0-preview2-1-003177\u00a0of the Command Line Tools.<\/p>\n

Packaging changes<\/strong><\/p>\n

Just like the three developer previews, the NuGet package will contain binaries for both the .NET Full Framework (targeting .NET 4.5 or greater), but also for .NET Core (targeting .NET Core 1.1). Depending on the target project you are including the dependency for, the correct binaries will be used.<\/p>\n

So, if your Visual Studio project is a .NET Full Framework application greater than or equal to 4.5, you’ll get the binaries for the full framework version of .NET. Likewise, if your application is a .NET Core application, then the .NET Core version of the binaries will be used. There should be nothing you have to do to enable this.<\/p>\n

The older .NET 4.5 version of the packages will no longer be released; 2.3.11 is the last supported release of the 2.3.X series.<\/p>\n

MS Logging for Core<\/strong><\/p>\n

For .NET Core we decided to change from using\u00a0Common.Logging<\/a>\u00a0to MS Logging mainly because no 3rd party (log4net<\/a>\u00a0for example) have stable support for .NET Core at this time.<\/p>\n

Additionally, by moving from Common.Logging<\/span>\u00a0 to MS Logging we have removed one more 3rd party dependency – which is always nice. Not that Common.Logging wasn’t sufficient, but it makes more sense to use a dependency from Microsoft.<\/p>\n

Here is an example of configuring the 2.4.0 client targeting .NET Core and using NLog:<\/p>\n

First add the dependencies to the project.json:<\/p>\n

{\r\n  \"version\": \"1.0.0-*\",\r\n  \"buildOptions\": {\r\n    \"emitEntryPoint\": true,\r\n    \"copyToOutput\": {\r\n      \"include\": [ \"config.json\", \"nlog.config\" ]\r\n    }\r\n  },\r\n\r\n  \"dependencies\": {\r\n    \"CouchbaseNetClient\": \"2.4.0-dp6\",\r\n    \"NLog.Extensions.Logging\": \"1.0.0-rtm-beta1\",\r\n    \"Microsoft.NETCore.App\": {\r\n      \"type\": \"platform\",\r\n      \"version\": \"1.0.1\"\r\n    },\r\n    \"Microsoft.Extensions.Logging.Debug\": \"1.1.0\",\r\n    \"Microsoft.Extensions.Logging\": \"1.1.0\"\r\n  },\r\n\r\n  \"frameworks\": {\r\n    \"netcoreapp1.0\": {\r\n      \"imports\": \"dnxcore50\"\r\n    }\r\n  }\r\n}<\/pre>\n
Then, add a\u00a0nlog.config\u00a0file to your project with the following contents:<\/p>\n
<?xml version=\"1.0\" encoding=\"utf-8\" ?>\r\n<nlog xmlns=\"https:\/\/www.nlog-project.org\/schemas\/NLog.xsd\"\r\n      xmlns:xsi=\"https:\/\/www.w3.org\/2001\/XMLSchema-instance\"\r\n      autoReload=\"true\"\r\n      internalLogLevel=\"Debug\"\r\n      internalLogFile=\"c:\\temp\\internal-nlog.txt\">\r\n\r\n  <!-- define various log targets -->\r\n  <targets>\r\n    <!-- write logs to file -->\r\n    <target xsi:type=\"File\" name=\"allfile\" fileName=\"c:\\temp\\nlog-all-${shortdate}.log\"\r\n                layout=\"${longdate}|${event-properties:item=EventId.Id}|${logger}|${uppercase:${level}}|${message} ${exception}\" \/>\r\n\r\n    <target xsi:type=\"Null\" name=\"blackhole\" \/>\r\n  <\/targets>\r\n\r\n  <rules>\r\n    <!--All logs, including from Microsoft-->\r\n    <logger name=\"*\" minlevel=\"Trace\" writeTo=\"allfile\" \/>\r\n  <\/rules>\r\n<\/nlog><\/pre>\n
Finally, add the code to configure the Couchbase SDK for logging:<\/p>\n
using Couchbase;\r\nusing Couchbase.Logging;\r\nusing Microsoft.Extensions.Logging;\r\nusing NLog.Extensions.Logging;\r\n\r\nnamespace ConsoleApp2\r\n{\r\n    public class Program\r\n    {\r\n        public static void Main(string[] args)\r\n        {\r\n            var factory = new LoggerFactory();\r\n            factory.AddDebug();\r\n            factory.AddNLog();\r\n            factory.ConfigureNLog(\"nlog.config\");\r\n\r\n            \/\/configure logging on the couchbase client\r\n            var config = new ClientConfiguration\r\n            {\r\n                LoggerFactory = factory\r\n            };\r\n\r\n            var cluster = new Cluster(config);\r\n            \/\/use the couchbase client\r\n        }\r\n    }\r\n}<\/pre>\n
Note that the project.json has a copyToOutput.include<\/span>\u00a0 value for nlog.config<\/span>\u00a0. This is required so the tooling will copy that file to the output directory when built.<\/p>\n
Now for the .NET 4.5 Full Framework binaries, the dependency on Common.Logging <\/span>\u00a0remains and any existing logging configuration should work as it always has.<\/p>\n
Datastructures<\/strong><\/p>\n
Datastructures are a new way of working with Couchbase documents as if they are a common Computer Science data structures such as\u00a0lists<\/em>,\u00a0queues<\/em>,\u00a0dictionaries<\/em>\u00a0or\u00a0sets<\/em>. There are two implementations in the SDK; one as a series of methods on CouchbaseBucket<\/span>\u00a0 which provide functionality for common data structure operations and another as implementations of the interfaces within System.Collections.Generics<\/span>\u00a0. Here is a description of each Datastructure class found in the SDK:<\/p>\n