com.couchbase.client.java.manager.query.QueryIndexManager Maven / Gradle / Ivy
Show all versions of java-client Show documentation
/*
* Copyright 2019 Couchbase, Inc.
*
* Licensed 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.
*/
package com.couchbase.client.java.manager.query;
import com.couchbase.client.core.annotation.Stability;
import com.couchbase.client.core.error.CouchbaseException;
import com.couchbase.client.core.error.IndexExistsException;
import com.couchbase.client.core.error.IndexFailureException;
import com.couchbase.client.core.error.IndexNotFoundException;
import com.couchbase.client.java.Cluster;
import java.time.Duration;
import java.util.Collection;
import java.util.List;
import static com.couchbase.client.java.AsyncUtils.block;
import static java.util.Objects.requireNonNull;
/**
* Performs management operations on query indexes.
*/
public class QueryIndexManager {
/**
* The underlying async query index manager which performs the actual ops and does the conversions.
*/
private final AsyncQueryIndexManager async;
/**
* Convenience access to the reactive index manager.
*/
private final ReactiveQueryIndexManager reactive;
/**
* Creates a new {@link QueryIndexManager}.
*
* This API is not intended to be called by the user directly, use {@link Cluster#queryIndexes()}
* instead.
*
* @param async the async index manager.
*/
@Stability.Internal
public QueryIndexManager(final AsyncQueryIndexManager async) {
this.async = requireNonNull(async);
this.reactive = new ReactiveQueryIndexManager(async);
}
/**
* Provides access to the {@link AsyncQueryIndexManager}.
*/
public AsyncQueryIndexManager async() {
return async;
}
/**
* Provides access to the {@link ReactiveQueryIndexManager}.
*/
public ReactiveQueryIndexManager reactive() {
return reactive;
}
/**
* Creates a primary query index.
*
* By default, this method will create an index on the bucket. If an index needs to be created on a collection,
* both {@link CreatePrimaryQueryIndexOptions#scopeName(String)} and
* {@link CreatePrimaryQueryIndexOptions#collectionName(String)} must be set.
*
* @param bucketName the name of the bucket to create the index on.
* @throws IndexFailureException if creating the index failed (see reason for details).
* @throws IndexExistsException if an index already exists with the given name on the keyspace.
* @throws CouchbaseException if any other generic unhandled/unexpected errors.
*/
public void createPrimaryIndex(final String bucketName) {
block(async.createPrimaryIndex(bucketName));
}
/**
* Creates a primary query index with custom options.
*
* By default, this method will create an index on the bucket. If an index needs to be created on a collection,
* both {@link CreatePrimaryQueryIndexOptions#scopeName(String)} and
* {@link CreatePrimaryQueryIndexOptions#collectionName(String)} must be set.
*
* @param bucketName the name of the bucket to create the index on.
* @param options the custom options to apply.
* @throws IndexFailureException if creating the index failed (see reason for details).
* @throws IndexExistsException if an index already exists with the given name on the keyspace.
* @throws CouchbaseException if any other generic unhandled/unexpected errors.
*/
public void createPrimaryIndex(final String bucketName, final CreatePrimaryQueryIndexOptions options) {
block(async.createPrimaryIndex(bucketName, options));
}
/**
* Creates a named query index.
*
* By default, this method will create an index on the bucket. If an index needs to be created on a collection,
* both {@link CreateQueryIndexOptions#scopeName(String)} and {@link CreateQueryIndexOptions#collectionName(String)}
* must be set.
*
* @param bucketName the name of the bucket to create the index on.
* @param indexName the name of the query index.
* @param fields the collection of fields that are part of the index.
* @throws IndexFailureException if creating the index failed (see reason for details).
* @throws IndexExistsException if an index already exists with the given name on the keyspace.
* @throws CouchbaseException if any other generic unhandled/unexpected errors.
*/
public void createIndex(final String bucketName, final String indexName, final Collection fields) {
block(async.createIndex(bucketName, indexName, fields));
}
/**
* Creates a named query index with custom options.
*
* By default, this method will create an index on the bucket. If an index needs to be created on a collection,
* both {@link CreateQueryIndexOptions#scopeName(String)} and {@link CreateQueryIndexOptions#collectionName(String)}
* must be set.
*
* @param bucketName the name of the bucket to create the index on.
* @param indexName the name of the query index.
* @param fields the collection of fields that are part of the index.
* @param options the custom options to apply.
* @throws IndexFailureException if creating the index failed (see reason for details).
* @throws IndexExistsException if an index already exists with the given name on the keyspace.
* @throws CouchbaseException if any other generic unhandled/unexpected errors.
*/
public void createIndex(final String bucketName, final String indexName, final Collection fields,
final CreateQueryIndexOptions options) {
block(async.createIndex(bucketName, indexName, fields, options));
}
/**
* Fetches all indexes from the bucket.
*
* By default, this method will fetch all index on the bucket. If the indexes should be loaded for a collection,
* both {@link GetAllQueryIndexesOptions#scopeName(String)} and
* {@link GetAllQueryIndexesOptions#collectionName(String)} must be set. If all indexes for a scope should be loaded,
* only the {@link GetAllQueryIndexesOptions#scopeName(String)} can be set.
*
* @param bucketName the name of the bucket to load the indexes from.
* @return a list of (potentially empty) indexes or failed with an error.
* @throws CouchbaseException if any other generic unhandled/unexpected errors.
*/
public List getAllIndexes(final String bucketName) {
return block(async.getAllIndexes(bucketName));
}
/**
* Fetches all indexes from the bucket with custom options.
*
* By default, this method will fetch all index on the bucket. If the indexes should be loaded for a collection,
* both {@link GetAllQueryIndexesOptions#scopeName(String)} and
* {@link GetAllQueryIndexesOptions#collectionName(String)} must be set. If all indexes for a scope should be loaded,
* only the {@link GetAllQueryIndexesOptions#scopeName(String)} can be set.
*
* @param bucketName the name of the bucket to load the indexes from.
* @param options the custom options to apply.
* @return a list of (potentially empty) indexes or failed with an error.
* @throws CouchbaseException if any other generic unhandled/unexpected errors.
*/
public List getAllIndexes(final String bucketName, final GetAllQueryIndexesOptions options) {
return block(async.getAllIndexes(bucketName, options));
}
/**
* Drops the primary index from a bucket.
*
* By default, this method will drop the primary index on the bucket. If the index should be dropped on a collection,
* both {@link DropPrimaryQueryIndexOptions#scopeName(String)} and
* {@link DropPrimaryQueryIndexOptions#collectionName(String)} must be set.
*
* @param bucketName the name of the bucket to drop the indexes from.
* @throws IndexNotFoundException if the index does not exist.
* @throws IndexFailureException if dropping the index failed (see reason for details).
* @throws CouchbaseException if any other generic unhandled/unexpected errors.
*/
public void dropPrimaryIndex(final String bucketName) {
block(async.dropPrimaryIndex(bucketName));
}
/**
* Drops the primary index from a bucket with custom options.
*
* By default, this method will drop the primary index on the bucket. If the index should be dropped on a collection,
* both {@link DropPrimaryQueryIndexOptions#scopeName(String)} and
* {@link DropPrimaryQueryIndexOptions#collectionName(String)} must be set.
*
* @param bucketName the name of the bucket to drop the indexes from.
* @param options the custom options to apply.
* @throws IndexNotFoundException if the index does not exist.
* @throws IndexFailureException if dropping the index failed (see reason for details).
* @throws CouchbaseException if any other generic unhandled/unexpected errors.
*/
public void dropPrimaryIndex(final String bucketName, final DropPrimaryQueryIndexOptions options) {
block(async.dropPrimaryIndex(bucketName, options));
}
/**
* Drops a query index from a bucket.
*
* By default, this method will drop the index on the bucket. If the index should be dropped on a collection,
* both {@link DropQueryIndexOptions#scopeName(String)} and
* {@link DropQueryIndexOptions#collectionName(String)} must be set.
*
* @param bucketName the name of the bucket to drop the indexes from.
* @param indexName the name of the index top drop.
* @throws IndexNotFoundException if the index does not exist.
* @throws IndexFailureException if dropping the index failed (see reason for details).
* @throws CouchbaseException if any other generic unhandled/unexpected errors.
*/
public void dropIndex(final String bucketName, final String indexName) {
block(async.dropIndex(bucketName, indexName));
}
/**
* Drops a query index from a bucket with custom options.
*
* By default, this method will drop the index on the bucket. If the index should be dropped on a collection,
* both {@link DropQueryIndexOptions#scopeName(String)} and
* {@link DropQueryIndexOptions#collectionName(String)} must be set.
*
* @param bucketName the name of the bucket to drop the indexes from.
* @param indexName the name of the index top drop.
* @param options the custom options to apply.
* @throws IndexNotFoundException if the index does not exist.
* @throws IndexFailureException if dropping the index failed (see reason for details).
* @throws CouchbaseException if any other generic unhandled/unexpected errors.
*/
public void dropIndex(final String bucketName, final String indexName, final DropQueryIndexOptions options) {
block(async.dropIndex(bucketName, indexName, options));
}
/**
* Builds all currently deferred indexes in the bucket's default collection.
*
* To target a different collection, see {@link #buildDeferredIndexes(String, BuildQueryIndexOptions)}.
*
* @param bucketName the name of the bucket to build deferred indexes for.
* @throws CouchbaseException if any other generic unhandled/unexpected errors.
*/
public void buildDeferredIndexes(final String bucketName) {
block(async.buildDeferredIndexes(bucketName));
}
/**
* Builds all currently deferred indexes in a collection.
*
* By default, this method targets the bucket's default collection.
* To target a different collection, specify both
* {@link BuildQueryIndexOptions#scopeName(String)} and
* {@link BuildQueryIndexOptions#collectionName(String)}.
*
* @param bucketName the name of the bucket to build deferred indexes for.
* @param options the custom options to apply.
* @throws CouchbaseException if any other generic unhandled/unexpected errors.
*/
public void buildDeferredIndexes(final String bucketName, final BuildQueryIndexOptions options) {
block(async.buildDeferredIndexes(bucketName, options));
}
/**
* Watches/Polls indexes until they are online.
*
* By default, this method will watch the indexes on the bucket. If the indexes should be watched on a collection,
* both {@link WatchQueryIndexesOptions#scopeName(String)} and
* {@link WatchQueryIndexesOptions#collectionName(String)} must be set.
*
* @param bucketName the name of the bucket where the indexes should be watched.
* @param indexNames the names of the indexes to watch.
* @param timeout the maximum amount of time the indexes should be watched.
* @throws CouchbaseException if any other generic unhandled/unexpected errors.
*/
public void watchIndexes(final String bucketName, final Collection indexNames, final Duration timeout) {
block(async.watchIndexes(bucketName, indexNames, timeout));
}
/**
* Watches/Polls indexes until they are online with custom options.
*
* By default, this method will watch the indexes on the bucket. If the indexes should be watched on a collection,
* both {@link WatchQueryIndexesOptions#scopeName(String)} and
* {@link WatchQueryIndexesOptions#collectionName(String)} must be set.
*
* @param bucketName the name of the bucket where the indexes should be watched.
* @param indexNames the names of the indexes to watch.
* @param timeout the maximum amount of time the indexes should be watched.
* @param options the custom options to apply.
* @throws CouchbaseException if any other generic unhandled/unexpected errors.
*/
public void watchIndexes(final String bucketName, final Collection indexNames, final Duration timeout,
final WatchQueryIndexesOptions options) {
block(async.watchIndexes(bucketName, indexNames, timeout, options));
}
}