Dremio Cloud
Dremio Software
 
On this page

    Home Space

    Each user has a private home space that can be used to upload local files, conduct tests, and perform other data experiments that you are not ready to share yet. The home space name entity cannot be modified or deleted. Catalog objects within the home space can be added, modified, and deleted.

    Home Space Object 
    {
    "entityType": "home",
    "id": "63505c60-bc86-42aa-a622-24e5f22ce50b",
    "name": "@test@dremio.com",
    "tag": "fdbc007c-6994-41c7-a578-e7bd0150d319",
    "children": [
        {
            "id": "bb606cd6-a2a1-4cdb-ab1e-7e6cfabe9cef",
            "path": [
                "@test@dremio.com",
                "SF Incidents"
            ],
            "tag": "4198a1d4-01d7-4d13-bf64-ea2661568963",
            "type": "DATASET",
            "datasetType": "VIRTUAL",
            "createdAt": "2021-05-21T20:41:17.148Z"
        },
        {
            "id": "ffbe8c1d-1db7-48d1-9c58-f452838fedc0",
            "path": [
                "@test@dremio.com",
                "test-folder"
            ],
            "tag": "b79b70f4-d4a7-4fb5-bfbb-dc00b1b29801",
            "type": "CONTAINER",
            "containerType": "FOLDER"
        }
    ]
}

    Home Space Attributes

    entityType

    String

    Specifies the type of catalog entity. For the home space, the type is home.

    id

    String (UUID)

    The UUID that is generated to identify the home space.

    Example 63505c60-bc86-42aa-a622-24e5f22ce50b

    name

    String

    The name of the home space. This name is automatically generated from the user's email (and is immutable).

    Example test@dremio.com

    tag

    String (UUID)

    The UUID that is generated to identify the instance of the home space. Dremio Cloud changes this tag whenever a change is made to the home space. Immutable by the user.

    Example fdbc007c-6994-41c7-a578-e7bd0150d319

    children

    [ CatalogEntitySummary ]

    The catalog entities (including datasets, files, and folders) contained in the home space.

    CatalogEntitySummary Attributes

    id

    String (UUID)

    The UUID that is generated to identify the catalog entity.

    Example bb606cd6-a2a1-4cdb-ab1e-7e6cfabe9cef

    path

    [String]

    The path of the entity.

    Example [ "test@dremio.com", "SF Incidents" ]

    tag

    String (UUID)

    The UUID that is generated to identify the instance of the entity. Dremio Cloud changes this tag whenever a change is made to the entity. Immutable by the user.

    Example 4198a1d4-01d7-4d13-bf64-ea2661568963

    type

    String

    The type of catalog entity that is in the home space.

    Enum CONTAINER , DATASET , FILE

    Example DATASET

    datasetType

    String

    Identifies the type of dataset.

    Enum VIRTUAL , PROMOTED , DIRECT

    Example VIRTUAL

    createdAt

    String

    The date and time that the entity was created.

    Example 2021-05-22T20:09:40.923Z

    containerType

    String

    Identifies the type of container that is in the home space. For the home space, the container type is FOLDER.

    Retrieving the Home Space

    Retrieve your home space and the datasets that it contains.

    Retrieving the Home Space 
    GET /v0/projects/{project-id}/catalog/{id}

    Parameters

    project-id

    path

    String (UUID)

    The UUID for the project that you want to retrieve the home space for.

    id

    path

    String (UUID)

    The UUID for the home space that you want to retrieve the metadata for.

    Example Request 
    curl -X GET 'https://api.dremio.cloud/v0/projects/02d36975-73eb-47ed-9bb5-de73060380f6/catalog/63505c60-bc86-42aa-a622-24e5f22ce50b' \
-H 'Authorization: Bearer <personal access token>' \
-H 'Content-Type: application/json'
    Example Response 
    {
    "entityType": "home",
    "id": "63505c60-bc86-42aa-a622-24e5f22ce50b",
    "name": "@test@dremio.com",
    "tag": "fdbc007c-6994-41c7-a578-e7bd0150d319",
    "children": [
        {
            "id": "bb606cd6-a2a1-4cdb-ab1e-7e6cfabe9cef",
            "path": [
                "@test@dremio.com",
                "SF Incidents"
            ],
            "tag": "4198a1d4-01d7-4d13-bf64-ea2661568963",
            "type": "DATASET",
            "datasetType": "VIRTUAL",
            "createdAt": "2021-05-21T20:41:17.148Z"
        },
        {
            "id": "ffbe8c1d-1db7-48d1-9c58-f452838fedc0",
            "path": [
                "@test@dremio.com",
                "test-folder"
            ],
            "tag": "b79b70f4-d4a7-4fb5-bfbb-dc00b1b29801",
            "type": "CONTAINER",
            "containerType": "FOLDER"
        }
    ]
}