com.couchbase.client.core.api.manager.CoreQueryIndex Maven / Gradle / Ivy
Show all versions of core-io Show documentation
/*
* Copyright 2023 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.core.api.manager;
import com.couchbase.client.core.annotation.Stability;
import com.couchbase.client.core.deps.com.fasterxml.jackson.databind.node.ArrayNode;
import com.couchbase.client.core.deps.com.fasterxml.jackson.databind.node.ObjectNode;
import com.couchbase.client.core.error.DecodingFailureException;
import com.couchbase.client.core.json.Mapper;
import com.couchbase.client.core.msg.query.QueryChunkRow;
import java.io.IOException;
import java.util.Optional;
import static com.couchbase.client.core.util.CbObjects.defaultIfNull;
import static com.couchbase.client.core.util.CbStrings.emptyToNull;
import static java.util.Objects.requireNonNull;
/**
* Contains the properties of a Query Index.
*/
@Stability.Internal
public class CoreQueryIndex {
private final String name;
private final boolean primary;
private final String state;
private final String keyspace;
private final String namespace;
private final ArrayNode indexKey;
private final String type;
private final Optional condition;
private final Optional partition;
private final ObjectNode raw;
private final Optional scopeName;
private final Optional bucketName;
public CoreQueryIndex(final QueryChunkRow row) {
try {
this.raw = (ObjectNode) Mapper.reader().readTree(requireNonNull(row.data()));
this.name = raw.path("name").textValue();
this.state = raw.path("state").textValue();
this.keyspace = raw.path("keyspace_id").textValue();
this.namespace = raw.path("namespace_id").textValue();
this.indexKey = (ArrayNode) raw.path("index_key");
this.condition = Optional.ofNullable(emptyToNull(raw.path("condition").textValue()));
this.primary = Boolean.TRUE.equals(raw.path("is_primary").asBoolean());
this.type = defaultIfNull(raw.path("using").textValue(), "gsi");
this.partition = Optional.ofNullable(emptyToNull(raw.path("partition").textValue()));
this.scopeName = Optional.ofNullable(emptyToNull(raw.path("scope_id").textValue()));
this.bucketName = Optional.ofNullable(emptyToNull(raw.path("bucket_id").textValue()));
}
catch (IOException e) {
throw new DecodingFailureException(e);
}
}
/**
* True if this index is a primary index.
*
* @return true if this index is a primary index.
*/
public boolean primary() {
return this.primary;
}
/**
* Returns the name of this index.
*
* @return the name of the index.
*/
public String name() {
return this.name;
}
/**
* Returns the index type (most likely "gsi").
*
* @return the type of the index.
*/
public String type() {
return type;
}
/**
* Returns the state in which the index is in (i.e. "online").
*
* @return the state of the index.
*/
public String state() {
return state;
}
/**
* Returns the keyspace of this index.
*
* If the index is at the bucket-level, this will return the bucket name. If the index is at the collection-level,
* the keyspace is the name of the collection.
*
* @return the keyspace of this index.
*/
public String keyspace() {
return keyspace;
}
/**
* @return the namespace for the index. A namespace is a resource pool that contains multiple keyspaces.
* @see #keyspace()
*/
/**
* Returns the namespace of this index.
*
* The namespace should not be confused with the keyspace - the namespace usually is "default".
*
* @return the namespace of this index.
*/
public String namespace() {
return namespace;
}
/**
* Returns an {@link ArrayNode array} of Strings that represent the index key(s).
*
* The array is empty in the case of a PRIMARY INDEX.
*
* Note that the query service can present the key in a slightly different manner from when you declared the index:
* for instance, it will show the indexed fields in an escaped format (surrounded by backticks).
*
* @return an array of Strings that represent the index key(s), or an empty array in the case of a PRIMARY index.
*/
public ArrayNode indexKey() {
return this.indexKey;
}
/**
* Returns the {@link String} representation of the index's condition (the WHERE clause of the index), or an empty
* Optional if no condition was set.
*
* Note that the query service can present the condition in a slightly different manner from when you declared the index:
* for instance it will wrap expressions with parentheses and show the fields in an escaped format (surrounded by
* backticks).
*
* @return the condition/WHERE clause of the index or empty string if none.
*/
public Optional condition() {
return this.condition;
}
/**
* If present, returns the configured partition for the index.
*
* @return the partition if set, empty if none.
*/
public Optional partition() {
return partition;
}
/**
* If present, returns the name of the scope this index is stored in.
*
* @return the name of the scope, if present.
*/
public Optional scopeName() {
return scopeName;
}
/**
* If present, returns the name of the bucket this index is stored in.
*
* @return the name of the bucket, if present.
*/
public String bucketName() {
return bucketName.orElse(keyspace);
}
/**
* If present, returns the name of the collection this index is stored in.
*
* @return the name of the collection, if present.
*/
public Optional collectionName() {
return bucketName.isPresent() && scopeName.isPresent() ? Optional.of(keyspace) : Optional.empty();
}
/**
* Returns the JSON as it arrived from the server.
*
* @return the raw JSON representation of the index information, as returned by the query service.
*/
public ObjectNode raw() {
return raw;
}
}