Click or drag to resize

CouchbaseSettings Class

Settings used to connect a Couchbase client to a Couchbase bucket.
Inheritance Hierarchy
SystemObject
  Neon.DataCouchbaseSettings

Namespace:  Neon.Data
Assembly:  Neon.Couchbase (in Neon.Couchbase.dll) Version: 2.1.0
Syntax
public class CouchbaseSettings

The CouchbaseSettings type exposes the following members.

Constructors
Properties
  NameDescription
Public propertyBucket
Optionally specifies the name of the target Couchbase bucket.
Public propertyConnectTimeout
Maximum time (milliseconds) to wait to establish a server connection (defaults to 10 seconds).
Public propertyIsValid
Returns true if the settings are valid.
Public propertyMaxPoolConnections
Maximum number of pooled connections to a server bucket (defaults to 5).
Public propertyMinPoolConnections
Minimum number of pooled connections to a server bucket (defaults to 2).
Public propertyOperationTimeout
Maximum time (milliseconds) to wait for an operation to complete (defaults to 10 seconds).
Public propertyQueryRequestTimeout
Maximum time (milliseconds) to wait for a non-view query to complete (defaults to 75 seconds).
Public propertySendTimeout
Maximum time (milliseconds) to wait to transmit a server request (defaults to 10 seconds).
Public propertyServers
One or more Couchbase server URIs.
Public propertyUseEnhancedDurability
Enables the use of the RequestPlus index consistency option. Both of these options are deprecated as of Couchbase 5.0 so this may no longer matter. This defaults to true.
Public propertyViewRequestTimeout
Maximum time (milliseconds) to wait for a view query to complete (defaults to 75 seconds).
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodStatic memberParse
Parses a CouchbaseSettings from a JSON or YAML string, automatically detecting the input format.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Extension Methods
  NameDescription
Public Extension MethodOpenBucket(Credentials, TimeSpan, NullableBoolean)Overloaded.
Returns a Couchbase bucket connection using specified settings and credentials.
(Defined by CouchbaseExtensions.)
Public Extension MethodOpenBucket(String, String, TimeSpan, NullableBoolean)Overloaded.
Returns a Couchbase bucket connection using specified settings and the cluster credentials.
(Defined by CouchbaseExtensions.)
Public Extension MethodOpenCluster(Credentials)Overloaded.
Returns a Couchbase cluster connection using specified settings and Credentials.
(Defined by CouchbaseExtensions.)
Public Extension MethodOpenCluster(String, String)Overloaded.
Returns a Couchbase cluster connection using specified settings and the username and password.
(Defined by CouchbaseExtensions.)
Public Extension MethodToClientConfig
Converts a CouchbaseSettings into a ClientConfiguration.
(Defined by CouchbaseExtensions.)
Top
See Also