Git Product home page Git Product logo

couchbase-net-client's Introduction

Couchbase .NET Client Library

This is the offical .NET client library for Couchbase Server.

Features:

The client currently provides support for Couchbase Server 1.8+.

  • Understands both the binary and text protocols
  • Highly configurable and extendable (custom configuration, serialization)
  • Supports consistent hashing
  • CheckAndSet operations
  • Persistent connections for more speed
  • SASL Authentication

Documentation

Documentation is maintained over at the Couchbase site. A good starting point for docs about the .Net client SDK is "Getting started with the Couchbase .Net client"

Requirements

You'll need .NET Framework 3.5 or later to use the precompiled binaries.

Distributed via NuGet

The client is distributed via NuGet, and to install it, just type:

PM> Install-Package CouchbaseNetClient

To get help started, read this introduction: "Getting started with the Couchbase .Net client"

Building the Client

Just clone your fork or the main repository:

git clone https://<your-user-name>@github.com/couchbase/couchbase-net-client

then locate and build the Couchbase.sln solution, using Visual Studio 2010 or later. The client uses NuGet package restore, hence any missing packages will be restored during the build, but you must ensure that your machine allows package restores.

Tests

By default the test project expects a local installation (localhost) of a Couchbase server. It should be configured to have a cluster user name: "Administrator" with password: "password".

Expected buckets are:

  • "default"
  • and a SASL enabled bucket, named: "authenticated" with the password: "secret".

To get the tests to run if you have a different setup then the above, just update values in the App.config file located in the test project Couchbase.Tests. E.g, lets say you have an installation running on a server alias cb1, then replace all http://localhost for http://cb1.

Getting Help

For help with the Couchbase .NET Client Library see the Couchbase SDK Forums.

Versioning Notes

We use the "Semantic Versioning 2.0" model described here for our versioning model: http://http://semver.org/ *All officially released binary's use the following convention: .. for example 1.2.9 or 1.3.0. *We occasionally provide snapshots of mid-iteration bug fixes for validation purposes. In which case we add another number ... where is a number starting at 5000 (e.g. 1.3.0.5000) and incremented with each build. *All snapshot builds are neither tested thoroughly nor supported in any way - user beware!

couchbase-net-client's People

Contributors

danielwertheim avatar enyim avatar ingenthr avatar jeffrymorris avatar jzablocki avatar mcpaddy avatar mnunberg avatar saakshimanocha avatar yopcix avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.