API
grai_source_cube
base

CubeIntegration Objects

class CubeIntegration(GraiIntegrationImplementation)

A class for extracting Grai compliant metadata from the Cube.dev REST API

__init__

def __init__(source: Union[SourceV1, SourceSpec],
             namespace: str,
             config: Optional[CubeApiConfig] = None,
             namespace_map: Optional[Union[NamespaceMap, Dict, str]] = None,
             version: str = "v1")

Initializes the Cube.js integration.

Arguments:

  • source - The Grai data source to associate with output from the integration.
  • namespace - The Grai namespace to associate with output from the integration
  • config - The connection configuration for your cube API. If not provided, an effort will be made to load these from the environment.
  • namespace_map - An optional mapping between cube data sources and Grai namespaces
  • version - The version of the Grai API to use for the integration

nodes

def nodes() -> List[SourcedNode]

Returns a list of SourcedNode objects

edges

def edges() -> List[SourcedEdge]

Returns a list of SourcedEdge objects

get_nodes_and_edges

def get_nodes_and_edges() -> Tuple[List[SourcedNode], List[SourcedEdge]]

Returns a tuple of lists of SourcedNode and SourcedEdge objects

ready

def ready() -> bool

Returns True if the integration is ready to run

apiconnector