What's New With 2.0.0
Last updated
Was this helpful?
Last updated
Was this helpful?
More than two years have passed since our SDK v1.1 was released. The SDK has been updated to support the new functionality available in Couchbase Server 4.x, including:
N1QL Queries
GSI Indexes
Replica Reads
Document Locking
Prepared Statements
Improved Design Document Management
Expanded Configuration Options
And more...
CFCouchbase uses the from Couchbase, when it went from version 1.x to 2.x breaking changes occurred (for the better). We have tried to mitigate these changes where possible. Many methods that were removed from the Java SDK and we created as facades for backwards compatibility. All of these methods have been marked from deprecation, but are still supported for the time being.
add()
=> insert()
decr()
=> counter()
incr()
=> counter()
delete()
=> remove()
set()
=> upsert()
setMulti()
=> upsertMulti()
setWithCAS()
> replaceWithCAS()
The SDK also brings many new methods, some of which we will cover in detail.
exists()
getAndLock()
getEnvironment()
getFromReplica()
invalidateQueryCache()
n1qlQuery()
publishDesignDocument()
replace()
unlock()
deserialize
deserializeOptions
inflateTo
filter
transform
The most basic (and fastest) N1QL operation is to retrieve document(s) by their document id.
Notice the FROM
clause, in this example "users" is the name of a bucket. This query can be described as:
"Get every property from the 'user_101' document in the 'users' bucket"
All N1QL queries will return an array, the response from this query would return an array of structures.
The USE KEYS
statement is not limited to single values either, multiple documents can be retrieved by declaring an array.
N1QL supports the standard DML operations that you would expect.
A common practice in SQL is to JOIN
results across tables. N1QL supports joining results in a bucket as well as across buckets. JOIN
statements utilize the USE KEYS
clause.
There may be instances where your application needs to prevent retrieval and updates to a given document. Document updates can be prevented by using the CAS operations, but this is not always guaranteed. The 2.0 SDK allows you to retrieve a document and lock it (for up to 30 seconds), then unlock it by updating it with CAS value at a later point in time.
Calls to retrieve or update document that has been locked, will fail until the document has been successfully unlocked or the maximum time of 30 seconds has passed.
With the changes from the 1.x to 2.x SDK the following configuration options are no longer supported:
maxReconnectDelay
obsPollInterval
obsPollMax
opQueueMaxBlockTime
opTimeout
readBufferSize
shouldOptimize
timeoutExceptionThreshold
One of the biggest additions to the SDK is support for (pronounced "nickel"). N1QL is a "SQL like" syntax for working with JSON documents in Couchbase Server. You can perform a N1QL query by calling the query(type="n1ql", statement="...")
method or by calling the n1qlQuery("...")
method directly. Just as with View queries, the same options are available to N1QL queries, this includes:
Up to this point our queries have used just an ID when working with documents. What if we wanted to find documents based on a properties value? To do this we need to create .
There are several for creating indexes, such as partitioning, building, covering, array indexing, etc. that are not covered in this post.
There are 44 new configuration options supported by the SDK. The options will allow you to tweak and tune your configuration to meet your needs. Examples include caseSensitiveKeys
, connectTimeout
, sslEnabled
, queryTimeout
. Please see the for detailed descriptions of each configuration option.
Please visit our page for all the necessary resources.