public class AnalyticsIndexManager extends Object
Constructor and Description |
---|
AnalyticsIndexManager(Cluster cluster)
Creates a new
AnalyticsIndexManager . |
Modifier and Type | Method and Description |
---|---|
AsyncAnalyticsIndexManager |
async()
Returns the async version of this index manager.
|
void |
connectLink()
Connects the analytics link for the default dataverse (Default.Local).
|
void |
connectLink(ConnectLinkAnalyticsOptions options)
Connects the analytics link for the default dataverse with custom options.
|
void |
createDataset(String datasetName,
String bucketName)
Creates a new dataset (analytics collection) if it does not already exist.
|
void |
createDataset(String datasetName,
String bucketName,
CreateDatasetAnalyticsOptions options)
Creates a new dataset (analytics collection) if it does not already exist with custom options.
|
void |
createDataverse(String dataverseName)
Creates a new dataverse (analytics scope) if it does not already exist.
|
void |
createDataverse(String dataverseName,
CreateDataverseAnalyticsOptions options)
Creates a new dataverse (analytics scope) if it does not already exist with custom options.
|
void |
createIndex(String indexName,
String datasetName,
Map<String,AnalyticsDataType> fields)
Creates a new analytics index if it does not exist.
|
void |
createIndex(String indexName,
String datasetName,
Map<String,AnalyticsDataType> fields,
CreateIndexAnalyticsOptions options)
Creates a new analytics index if it does not exist with custom options.
|
void |
createLink(AnalyticsLink link)
Creates a new analytics link.
|
void |
createLink(AnalyticsLink link,
CreateLinkAnalyticsOptions options)
Creates a new analytics link with custom options.
|
void |
disconnectLink()
Disconnects the analytics link for the default dataverse (Default.Local).
|
void |
disconnectLink(DisconnectLinkAnalyticsOptions options)
Disconnects the analytics link for the default dataverse with custom options.
|
void |
dropDataset(String datasetName)
Drops (deletes) a dataset.
|
void |
dropDataset(String datasetName,
DropDatasetAnalyticsOptions options)
Drops (deletes) a dataset with custom options.
|
void |
dropDataverse(String dataverseName)
Drops (deletes) a dataverse.
|
void |
dropDataverse(String dataverseName,
DropDataverseAnalyticsOptions options)
Drops (deletes) a dataverse with custom options.
|
void |
dropIndex(String indexName,
String datasetName)
Drops (removes) an index if it exists.
|
void |
dropIndex(String indexName,
String datasetName,
DropIndexAnalyticsOptions options)
Drops (removes) an index if it exists with custom options.
|
void |
dropLink(String linkName,
String dataverse)
Drops (removes) a link if it exists.
|
void |
dropLink(String linkName,
String dataverse,
DropLinkAnalyticsOptions options)
Drops (removes) a link if it exists with custom options.
|
List<AnalyticsDataset> |
getAllDatasets()
Fetches all datasets (analytics collections) from the analytics service.
|
List<AnalyticsDataset> |
getAllDatasets(GetAllDatasetsAnalyticsOptions options)
Fetches all datasets (analytics collections) from the analytics service with custom options.
|
List<AnalyticsDataverse> |
getAllDataverses()
Fetches all dataverses (analytics scopes) from the analytics service.
|
List<AnalyticsDataverse> |
getAllDataverses(GetAllDataversesAnalyticsOptions options)
Fetches all dataverses (analytics scopes) from the analytics service with custom options.
|
List<AnalyticsIndex> |
getAllIndexes()
Lists all analytics indexes.
|
List<AnalyticsIndex> |
getAllIndexes(GetAllIndexesAnalyticsOptions options)
Lists all analytics indexes with custom options.
|
List<AnalyticsLink> |
getLinks()
Returns a (potentially empty) list of current analytics links.
|
List<AnalyticsLink> |
getLinks(GetLinksAnalyticsOptions options)
Returns a (potentially empty) list of current analytics links with custom options.
|
Map<String,Map<String,Long>> |
getPendingMutations()
Returns the pending mutations for different dataverses.
|
Map<String,Map<String,Long>> |
getPendingMutations(GetPendingMutationsAnalyticsOptions options)
Returns the pending mutations for different dataverses with custom options.
|
ReactiveAnalyticsIndexManager |
reactive()
Returns the reactive version of this index manager.
|
void |
replaceLink(AnalyticsLink link)
Replaces an existing analytics link.
|
void |
replaceLink(AnalyticsLink link,
ReplaceLinkAnalyticsOptions options)
Replaces an analytics link with custom options.
|
@Stability.Internal public AnalyticsIndexManager(Cluster cluster)
AnalyticsIndexManager
.
This API is not intended to be called by the user directly, use Cluster.analyticsIndexes()
instead.
cluster
- the async cluster to perform the analytics queries on.public AsyncAnalyticsIndexManager async()
public ReactiveAnalyticsIndexManager reactive()
public void createDataverse(String dataverseName)
dataverseName
- the name of the dataverse to create.com.couchbase.client.core.error.DataverseExistsException
- if the dataverse already exists.com.couchbase.client.core.error.CouchbaseException
- if any other generic unhandled/unexpected errors.public void createDataverse(String dataverseName, CreateDataverseAnalyticsOptions options)
dataverseName
- the name of the dataverse to create.options
- the custom options to apply.com.couchbase.client.core.error.DataverseExistsException
- if the dataverse already exists.com.couchbase.client.core.error.CouchbaseException
- if any other generic unhandled/unexpected errors.public void dropDataverse(String dataverseName)
dataverseName
- the name of the dataverse to drop.com.couchbase.client.core.error.DataverseNotFoundException
- if the dataverse does not exist.com.couchbase.client.core.error.CompilationFailureException
- if a dataverse that cannot be dropped (i.e. Default) is attempted.com.couchbase.client.core.error.CouchbaseException
- if any other generic unhandled/unexpected errors.public void dropDataverse(String dataverseName, DropDataverseAnalyticsOptions options)
dataverseName
- the name of the dataverse to drop.options
- the custom options to apply.com.couchbase.client.core.error.DataverseNotFoundException
- if the dataverse does not exist.com.couchbase.client.core.error.CompilationFailureException
- if a dataverse that cannot be dropped (i.e. Default) is attempted.com.couchbase.client.core.error.CouchbaseException
- if any other generic unhandled/unexpected errors.@Stability.Uncommitted public List<AnalyticsDataverse> getAllDataverses(GetAllDataversesAnalyticsOptions options)
options
- the custom options to apply.com.couchbase.client.core.error.CouchbaseException
- if any other generic unhandled/unexpected errors.@Stability.Uncommitted public List<AnalyticsDataverse> getAllDataverses()
com.couchbase.client.core.error.CouchbaseException
- if any other generic unhandled/unexpected errors.public void createDataset(String datasetName, String bucketName)
datasetName
- the name of the dataset to create.bucketName
- the name of the bucket where the dataset is stored inside.com.couchbase.client.core.error.DatasetExistsException
- if the dataset already exists.com.couchbase.client.core.error.CouchbaseException
- if any other generic unhandled/unexpected errors.public void createDataset(String datasetName, String bucketName, CreateDatasetAnalyticsOptions options)
datasetName
- the name of the dataset to create.bucketName
- the name of the bucket where the dataset is stored inside.options
- the custom options to apply.com.couchbase.client.core.error.DatasetExistsException
- if the dataset already exists.com.couchbase.client.core.error.CouchbaseException
- if any other generic unhandled/unexpected errors.public void dropDataset(String datasetName)
datasetName
- the name of the dataset to create.com.couchbase.client.core.error.DatasetNotFoundException
- if the dataset to drop does not exist.com.couchbase.client.core.error.CouchbaseException
- if any other generic unhandled/unexpected errors.public void dropDataset(String datasetName, DropDatasetAnalyticsOptions options)
datasetName
- the name of the dataset to create.options
- the custom options to apply.com.couchbase.client.core.error.DatasetNotFoundException
- if the dataset to drop does not exist.com.couchbase.client.core.error.CouchbaseException
- if any other generic unhandled/unexpected errors.public List<AnalyticsDataset> getAllDatasets()
com.couchbase.client.core.error.CouchbaseException
- if any other generic unhandled/unexpected errors.public List<AnalyticsDataset> getAllDatasets(GetAllDatasetsAnalyticsOptions options)
options
- the custom options to apply.com.couchbase.client.core.error.CouchbaseException
- if any other generic unhandled/unexpected errors.public void createIndex(String indexName, String datasetName, Map<String,AnalyticsDataType> fields)
indexName
- the name of the index to create.datasetName
- the name of the dataset in which the index should be created.fields
- the fields that should be indexed.com.couchbase.client.core.error.IndexExistsException
- if the index already exists and not ignored in the options.com.couchbase.client.core.error.DataverseNotFoundException
- if a dataverse is provided in the options that does not exist.com.couchbase.client.core.error.DatasetNotFoundException
- if a dataset is provided which does not exist.com.couchbase.client.core.error.CouchbaseException
- if any other generic unhandled/unexpected errors.public void createIndex(String indexName, String datasetName, Map<String,AnalyticsDataType> fields, CreateIndexAnalyticsOptions options)
indexName
- the name of the index to create.datasetName
- the name of the dataset in which the index should be created.fields
- the fields that should be indexed.options
- the custom options to apply.com.couchbase.client.core.error.IndexExistsException
- if the index already exists and not ignored in the options.com.couchbase.client.core.error.DataverseNotFoundException
- if a dataverse is provided in the options that does not exist.com.couchbase.client.core.error.DatasetNotFoundException
- if a dataset is provided which does not exist.com.couchbase.client.core.error.CouchbaseException
- if any other generic unhandled/unexpected errors.public void dropIndex(String indexName, String datasetName)
indexName
- the name of the index to drop.datasetName
- the dataset in which the index exists.com.couchbase.client.core.error.IndexNotFoundException
- if the index does not exist and not ignored via options.com.couchbase.client.core.error.DataverseNotFoundException
- if a dataverse is provided in the options that does not exist.com.couchbase.client.core.error.DatasetNotFoundException
- if a dataset is provided which does not exist.com.couchbase.client.core.error.CouchbaseException
- if any other generic unhandled/unexpected errors.public void dropIndex(String indexName, String datasetName, DropIndexAnalyticsOptions options)
indexName
- the name of the index to drop.datasetName
- the dataset in which the index exists.options
- the custom options to apply.com.couchbase.client.core.error.IndexNotFoundException
- if the index does not exist and not ignored via options.com.couchbase.client.core.error.DataverseNotFoundException
- if a dataverse is provided in the options that does not exist.com.couchbase.client.core.error.DatasetNotFoundException
- if a dataset is provided which does not exist.com.couchbase.client.core.error.CouchbaseException
- if any other generic unhandled/unexpected errors.public List<AnalyticsIndex> getAllIndexes()
com.couchbase.client.core.error.CouchbaseException
- if any other generic unhandled/unexpected errors.public List<AnalyticsIndex> getAllIndexes(GetAllIndexesAnalyticsOptions options)
options
- the custom options to apply.com.couchbase.client.core.error.CouchbaseException
- if any other generic unhandled/unexpected errors.public void connectLink()
com.couchbase.client.core.error.CouchbaseException
- if any other generic unhandled/unexpected errors.public void connectLink(ConnectLinkAnalyticsOptions options)
options
- the custom options to apply.com.couchbase.client.core.error.LinkNotFoundException
- if the link does not exist.com.couchbase.client.core.error.DataverseNotFoundException
- if a dataverse is provided in the options that does not exist.com.couchbase.client.core.error.CouchbaseException
- if any other generic unhandled/unexpected errors.public void disconnectLink()
com.couchbase.client.core.error.CouchbaseException
- if any other generic unhandled/unexpected errors.public void disconnectLink(DisconnectLinkAnalyticsOptions options)
options
- the custom options to apply.com.couchbase.client.core.error.LinkNotFoundException
- if the link does not exist.com.couchbase.client.core.error.DataverseNotFoundException
- if a dataverse is provided in the options that does not exist.com.couchbase.client.core.error.CouchbaseException
- if any other generic unhandled/unexpected errors.public Map<String,Map<String,Long>> getPendingMutations()
com.couchbase.client.core.error.CouchbaseException
- if any other generic unhandled/unexpected errors.public Map<String,Map<String,Long>> getPendingMutations(GetPendingMutationsAnalyticsOptions options)
options
- the custom options to apply.com.couchbase.client.core.error.CouchbaseException
- if any other generic unhandled/unexpected errors.public void createLink(AnalyticsLink link)
link
- the name of the link that should be created.com.couchbase.client.core.error.InvalidArgumentException
- if required parameters are not supplied or are invalid.com.couchbase.client.core.error.AuthenticationFailureException
- if the remote link cannot be authenticated on creation.com.couchbase.client.core.error.LinkExistsException
- if the link with the name already exists.com.couchbase.client.core.error.CouchbaseException
- if any other generic unhandled/unexpected errors.public void createLink(AnalyticsLink link, CreateLinkAnalyticsOptions options)
link
- the name of the link that should be created.options
- the custom options to apply.com.couchbase.client.core.error.InvalidArgumentException
- if required parameters are not supplied or are invalid.com.couchbase.client.core.error.AuthenticationFailureException
- if the remote link cannot be authenticated on creation.com.couchbase.client.core.error.LinkExistsException
- if the link with the name already exists.com.couchbase.client.core.error.CouchbaseException
- if any other generic unhandled/unexpected errors.public void replaceLink(AnalyticsLink link)
link
- the name of the link that should be replaced.com.couchbase.client.core.error.InvalidArgumentException
- if required parameters are not supplied or are invalid.com.couchbase.client.core.error.AuthenticationFailureException
- if the remote link cannot be authenticated on replace.com.couchbase.client.core.error.LinkNotFoundException
- if the link does not exist.com.couchbase.client.core.error.CouchbaseException
- if any other generic unhandled/unexpected errors.public void replaceLink(AnalyticsLink link, ReplaceLinkAnalyticsOptions options)
link
- the name of the link that should be replaced.options
- the custom options to apply.com.couchbase.client.core.error.InvalidArgumentException
- if required parameters are not supplied or are invalid.com.couchbase.client.core.error.AuthenticationFailureException
- if the remote link cannot be authenticated on replace.com.couchbase.client.core.error.LinkNotFoundException
- if the link does not exist.com.couchbase.client.core.error.CouchbaseException
- if any other generic unhandled/unexpected errors.public void dropLink(String linkName, String dataverse)
linkName
- the name of the link that should be dropped.dataverse
- the name of the dataverse in which the link exists.com.couchbase.client.core.error.LinkNotFoundException
- if the link does not exist.com.couchbase.client.core.error.DataverseNotFoundException
- if a dataverse is provided that does not exist.com.couchbase.client.core.error.CouchbaseException
- if any other generic unhandled/unexpected errors.public void dropLink(String linkName, String dataverse, DropLinkAnalyticsOptions options)
linkName
- the name of the link that should be dropped.dataverse
- the name of the dataverse in which the link exists.options
- the custom options to apply.com.couchbase.client.core.error.LinkNotFoundException
- if the link does not exist.com.couchbase.client.core.error.DataverseNotFoundException
- if a dataverse is provided that does not exist.com.couchbase.client.core.error.CouchbaseException
- if any other generic unhandled/unexpected errors.public List<AnalyticsLink> getLinks()
Links describe connections between an external data source and the analytics engine. Note that
AnalyticsLink
is an abstract class and has implementations depending on the type of link configured. See
and cast into S3ExternalAnalyticsLink
, or CouchbaseRemoteAnalyticsLink
for specific attributes. In
the future, more external link types might be supported - please consult the server documentation for more
information.
com.couchbase.client.core.error.DataverseNotFoundException
- if a dataverse is provided in the options that does not exist.com.couchbase.client.core.error.CouchbaseException
- if any other generic unhandled/unexpected errors.public List<AnalyticsLink> getLinks(GetLinksAnalyticsOptions options)
Links describe connections between an external data source and the analytics engine. Note that
AnalyticsLink
is an abstract class and has implementations depending on the type of link configured. See
and cast into S3ExternalAnalyticsLink
, or CouchbaseRemoteAnalyticsLink
for specific attributes. In
the future, more external link types might be supported - please consult the server documentation for more
information.
options
- the custom options to apply.com.couchbase.client.core.error.DataverseNotFoundException
- if a dataverse is provided in the options that does not exist.com.couchbase.client.core.error.CouchbaseException
- if any other generic unhandled/unexpected errors.Copyright © 2024 Couchbase, Inc.. All rights reserved.