Documentation

AnalyticsIndexManager
in package

Table of Contents

$core  : resource
connectLink()  : void
Connects the analytics link (by default, `Default.Local`)
createDataset()  : void
Creates a new analytics dataset
createDataverse()  : void
Creates a new analytics dataverse.
createIndex()  : void
Creates a new analytics index.
createLink()  : void
Creates a new analytics link.
disconnectLink()  : void
Disconnects the analytics link (by default, `Default.local`)
dropDataset()  : void
Deletes an analytics dataset
dropDataverse()  : void
Deletes an analytics dataverse.
dropIndex()  : void
Deletes an analytics index
dropLink()  : void
Deletes an analytics link.
getAllDatasets()  : array<string|int, mixed>
Fetches all datasets from the analytics service
getAllIndexes()  : array<string|int, mixed>
Fetches all indexes from the analytics service.
getLinks()  : array<string|int, mixed>
Returns a list of current analytics links.
getPendingMutations()  : array<string|int, mixed>
Fetches the pending mutations for different dataverses.
replaceLink()  : void
Replaces an existing analytics link.

Properties

Methods

createDataset()

Creates a new analytics dataset

public createDataset(string $datasetName, string $bucketName[, CreateAnalyticsDatasetOptions|null $options = null ]) : void
Parameters
$datasetName : string

The name of the dataset to create

$bucketName : string

The name of the bucket where the dataset is stored inside

$options : CreateAnalyticsDatasetOptions|null = null

The options to use when creating the dataset

Tags
since
4.2.4
Return values
void

createIndex()

Creates a new analytics index.

public createIndex(string $datasetName, string $indexName, array<string|int, mixed> $fields[, CreateAnalyticsIndexOptions|null $options = null ]) : void
Parameters
$datasetName : string

The name of the dataset in which the index should be created

$indexName : string

The name of the index to create

$fields : array<string|int, mixed>

The fields that should be indexed.

$options : CreateAnalyticsIndexOptions|null = null

The options to use when creating the index.

Tags
since
4.2.4
Return values
void

Creates a new analytics link.

public createLink(AnalyticsLink $link[, CreateAnalyticsLinkOptions|null $options = null ]) : void
Parameters
$link : AnalyticsLink

The link that should be created. Either a Couchbase, s3, or azureblob link.

$options : CreateAnalyticsLinkOptions|null = null

The options to use when creating the link

Tags
see
CouchbaseRemoteAnalyticsLink
see
S3ExternalAnalyticsLink
see
AzureBlobExternalAnalyticsLink
since
4.2.4
Return values
void

dropIndex()

Deletes an analytics index

public dropIndex(string $datasetName, string $indexName[, DropAnalyticsIndexOptions|null $options = null ]) : void
Parameters
$datasetName : string

The name of the dataset in which the index exists

$indexName : string

The name of the index to drop

$options : DropAnalyticsIndexOptions|null = null

The options to use when dropping the index

Tags
since
4.2.4
Return values
void

Deletes an analytics link.

public dropLink(string $linkName, string $dataverseName[, DropAnalyticsLinkOptions|null $options = null ]) : void
Parameters
$linkName : string

The name of the link

$dataverseName : string

The dataverse in which the link exists

$options : DropAnalyticsLinkOptions|null = null

The options to use when replacing hte link.

Tags
since
4.2.4
Return values
void

getPendingMutations()

Fetches the pending mutations for different dataverses.

public getPendingMutations([GetAnalyticsPendingMutationsOptions|null $options = null ]) : array<string|int, mixed>
Parameters
$options : GetAnalyticsPendingMutationsOptions|null = null

The options to use when fetching the pending mutations

Tags
since
4.2.4
Return values
array<string|int, mixed>

Associative array where top level keys are dataverse names, and values are an associative array of datasets to number of pending mutations.

Replaces an existing analytics link.

public replaceLink(AnalyticsLink $link[, ReplaceAnalyticsLinkOptions|null $options = null ]) : void
Parameters
$link : AnalyticsLink

The link that should be replaced, Either a Couchbase, s3, or azureblob link.

$options : ReplaceAnalyticsLinkOptions|null = null

The options to use when replacing the link

Tags
see
CouchbaseRemoteAnalyticsLink
see
S3ExternalAnalyticsLink
see
AzureBlobExternalAnalyticsLink
since
4.2.4
Return values
void

        

Search results