On this page

    Source Container

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

    Source Parameters

    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,
      "accelerationNeverExpire": Boolean [introduced in Dremio 3.1],
      "accelerationNeverRefresh": Boolean [introduced in Dremio 3.1]
    }
    
    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 Types Immutable after creation.
    configObjectSource Type Configuration based on the specified source type.
    createdAtStringRFC3339 date (example: 2017-10-27T21:08:22.858Z) representing the creation datetime. Immutable.
    metadataPolicy[Source metadata]Source Metadata Policy Policies regarding updating of a source’s metadata.
    state[Source State]State 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.
    accelerationNeverExpireBooleanIf set to true, accelerations will never expire. This overrides the accelerationGracePeriodMs setting.
    accelerationNeverRefreshBooleanIf set to true, accelerations will never be refreshed automatically. This overrides the accelerationRefreshPeriodMs setting.

    Source State

    Represents the state of a source.

    {
      "status": String ["good", "bad", "warn"] [immutable],
      "messages": [StatusMessage] [immutable]
    }
    
    NameTypeDescription
    statusStringEither info, bad, or warn. Immutable
    messagesStatusMessage[]An array of Source Status Messages. Immutable.

    Source Status Message

    Represents a status message for a source.

    {
      "level": String ["INFO", "WARN", "ERROR"] [immutable],
      "message": String [immutable]
    }
    
    NameTypeDescription
    statusStringEither INFO, WARN, or ERROR. Immutable.
    messageStringStatus message. Immutable.

    For More Information