com.basho.riak.client.bucket.package-info Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of riak-client Show documentation

HttpClient-based client for Riak

There is a newer version: 2.1.1

/*
 * This file is provided to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */
/**
 * A bucket is a namespace abstraction provided by Riak, the API uses
 * {@link com.basho.riak.client.bucket.Bucket} as the primary way to interact
 * with data stored in Riak.
 * 
 * All data in Riak is stored under a bucket/key namespace. After you have
 * obtained a {@link com.basho.riak.client.bucket.Bucket} from the
 * {@link com.basho.riak.client.IRiakClient}, use it to fetch, store and delete
 * data.
 * 
 * 
 * For example
 * 
 * 
 * 
 * 
 *   final String bucketName = UUID.randomUUID().toString();
 *   
 *   Bucket b = client.fetchBucket(bucketName).execute();
 *   //store something
 *   IRiakObject o = b.store("k", "v").execute();
 *   //fetch it back
 *   IRiakObject fetched = b.fetch("k").execute();
 *   // now update that riak object
 *   b.store("k", "my new value").execute();
 *   //fetch it back again
 *   fetched = b.fetch("k").execute();
 *   //delete it
 *   b.delete("k").execute();
 * 
 * 
 * 
 * {@link com.basho.riak.client.bucket.Bucket} extends the
 * {@link com.basho.riak.client.bucket.BucketProperties} interface for access to
 * bucket schema information (like n_val, allow_mult,
 * default r quorum etc.)
 * 
 * 
 * This package also provides a {@link com.basho.riak.client.bucket.DomainBucket} for
 * wrapping a {@link com.basho.riak.client.bucket.Bucket}. A
 * {@link com.basho.riak.client.bucket.DomainBucket} simplifies working with a
 * bucket that only has one type of data in it.
 * {@link com.basho.riak.client.bucket.RiakBucket} is a
 * {@link com.basho.riak.client.bucket.DomainBucket} for working with
 * {@link com.basho.riak.client.IRiakObject}s.
 * 
 * @see com.basho.riak.client.bucket.Bucket
 * @see com.basho.riak.client.bucket.DomainBucket
 * @see com.basho.riak.client.bucket.RiakBucket
 */
package com.basho.riak.client.bucket;