On this page

    Top-level Containers

    This section describes the top-level containers: home, space, and source.

    Home

    Represents a home space in Dremio. All home spaces returned by the REST API have an entityType of home.

    The JSON representation of a home space looks like this:

    {
      "entityType": "home" [immutable, generated by Dremio],
      "id": String [immutable, generated by Dremio],
      "name": String [immutable, generated by Dremio],
      "tag": String [immutable, generated by Dremio],
      "children": [CatalogEntitySummary] [optional] [immutable, generated by Dremio]
    }
    
    NameTypeDescription
    idStringHome space ID. Generated by Dremio, immutable.
    nameStringName of the home space. Generated by Dremio, immutable.
    tagStringIdentifies the instance of the home space, changed each time it is modified. Generated by Dremio, immutable.
    children[CatalogEntitySummary]The children of the home space. Optional, immutable.

    Space

    Represents a space in Dremio. All spaces returned by the REST API have an entityType of space.

    The JSON representation of a space looks like this:

    {
      "entityType": "space" [immutable after creation],
      "id": String [immutable, generated by Dremio],
      "name": String [immutable after creation],
      "tag": String [immutable, generated by Dremio],
      "children": [CatalogEntitySummary] [optional] [immutable, generated by Dremio]
    }
    
    NameTypeDescription
    idStringSource ID. Generated by Dremio, immutable.
    nameStringName of the space. Immutable after creation.
    tagStringIdentifies the instance of the space, changed each time it is modified. Generated by Dremio, immutable.
    createdAtStringRFC3339 date (example: 2017-10-27T21:08:22.858Z) representing the creation datetime. Immutable.
    children[CatalogEntitySummary]The children of the space. Optional, immutable.

    Source

    Represents a source in Dremio. All sources returned by the REST API have an entityType of source.

    The JSON representation of a source looks like this:

    {
      "entityType": "source" [immutable after creation,
      "id": String [immutable, generated by Dremio],
      "name": String [immutable after creation],
      "description": String,
      "tag": String [immutable, generated by Dremio],
      "type": String (Source Type) [immutable after creation],
      "config": Object (Source Config),
      "createdAt": String (RFC3339 date) [immutable],
      "metadataPolicy": {
        "authTTLMs": Number,
        "datasetRefreshAfterMs": Number,
        "datasetExpireAfterMs": Number,
        "namesRefreshMs": Number,
        "datasetUpdateMode": String ["PREFETCH", "PREFETCH_QUERIED", "INLINE"]
      },
      "state": {
        "status": String ["good", "bad", "warn"] [immutable, generated by Dremio],
        "messages": [Status Message] [immutable, generated by Dremio]
      },
      "accelerationRefreshPeriodMs": Number,
      "accelerationGracePeriodMs": Number
    }
    
    NameTypeDescription
    idStringSource ID. Generated by Dremio, immutable.
    nameStringName of the source. Immutable after creation.
    descriptionStringDetailed description.
    tagStringIdentifies the instance of the source, changed each time a source is modified. Generated by Dremio, immutable.
    typeStringSource type. Immutable after creation.
    configObjectSource config based on the specified source type.
    createdAtStringRFC3339 date (example: 2017-10-27T21:08:22.858Z) representing the creation datetime. Immutable.
    metadataPolicyMetadata PolicyPolicies regarding updating of a source’s metadata.
    stateSource StateState of the source. Generated by Dremio, immutable.
    accelerationRefreshPeriodMsNumberHow often to refresh reflections on data in the source.
    accelerationGracePeriodMsNumberHow long to keep reflections on data in the source before it expires.