LocalClusterConnection is a datatype for a local cluster connection. It implements the interface datatype, ClusterConnection.

This datatype is used by the createLocalClusterConnection() and the updateLocalClusterConnection() mutations fields, as well as the checkLocalClusterConnection() query field.

Table: LocalClusterConnection

ParameterTypeRequiredDefaultStabilityDescription
Some input parameters may be required, as indicated in the Required column. For return values, this indicates that you are assured a value if the field is requested for the results.
Table last updated: Mar 26, 2025
clusterIdstringyes Short-TermThe cluster identity of the connection.
idstringyes Short-TermThe unique identifier of the connection.
queryPrefixstringyes Short-TermThe cluster connection query prefix.
tags[ClusterConnectionTag]yes Short-TermThe cluster connection tags. See ClusterConnectionTag.
targetViewIdstringyes Short-TermThe unique identifier of the local view with which to connect.
targetViewNameRepoOrViewNameyes Short-TermThe name of the local view with which to connect. RepoOrViewName is a scalar.
targetViewTypeLocalTargetTypeyes Short-TermThe type of target view. See LocalTargetType.