dremio_client.model package

Submodules

dremio_client.model.catalog module

dremio_client.model.catalog.catalog(token, base_url, flight_endpoint, ssl_verify=True)[source]

dremio_client.model.data module

class dremio_client.model.data.AccessControl(id=None, permissions=None)[source]

Bases: object

to_json()[source]
class dremio_client.model.data.AccessControlList(users=None, groups=None, version=None)[source]

Bases: object

to_json()[source]
class dremio_client.model.data.Catalog(token=None, base_url=None, flight_endpoint=None, ssl_verify=True, dirty=False)[source]

Bases: dict

commit()[source]
delete()[source]
get()[source]

Return the value for key if key is in the dictionary, else default.

insert(entity_type, name, commit=True, **kwargs)[source]
keys() → a set-like object providing a view on D's keys[source]
promote(file_format='parquet', **kwargs)[source]

promote this file/folder to a PDS

Note

can only be run on a file or folder in a Source

Parameters:file_format – file format of the file/folder (only parquet, xls, excel, json, text are accepted)

:return None

refresh()[source]
remove()[source]
tags()[source]
to_json()[source]
wiki()[source]
class dremio_client.model.data.Dataset(token=None, base_url=None, flight_endpoint=None, ssl_verify=True, dirty=False, **kwargs)[source]

Bases: dremio_client.model.data.Catalog

get_graph()[source]
get_table()[source]
query()[source]
sql(sql)[source]
class dremio_client.model.data.DatasetMetaData(entityType=None, id=None, path=None, tag=None, type=None, fields=None, createdAt=None, accelerationRefreshPolicy=None, sql=None, sqlContext=None, format=None, approximateStatisticsAllowed=None, accessControlList=None)[source]

Bases: object

to_json()[source]
class dremio_client.model.data.File(token=None, base_url=None, flight_endpoint=None, ssl_verify=True, dirty=False, **kwargs)[source]

Bases: dremio_client.model.data.Catalog

class dremio_client.model.data.FileMetaData(entityType=None, id=None, path=None, accessControlList=None)[source]

Bases: object

to_json()[source]
class dremio_client.model.data.Folder(token=None, base_url=None, flight_endpoint=None, ssl_verify=True, dirty=False, **kwargs)[source]

Bases: dremio_client.model.data.Catalog

class dremio_client.model.data.FolderMetaData(entityType=None, id=None, path=None, tag=None, accessControlList=None)[source]

Bases: object

to_json()[source]
class dremio_client.model.data.Home(token=None, base_url=None, flight_endpoint=None, ssl_verify=True, dirty=False, **kwargs)[source]

Bases: dremio_client.model.data.Space

class dremio_client.model.data.MetadataPolicy(authTTLMs=None, datasetRefreshAfterMs=None, datasetExpireAfterMs=None, namesRefreshMs=None, datasetUpdateMode=None)[source]

Bases: object

to_json()[source]
class dremio_client.model.data.PhysicalDataset(token=None, base_url=None, flight_endpoint=None, ssl_verify=True, dirty=False, **kwargs)[source]

Bases: dremio_client.model.data.Dataset

metadata_refresh()[source]
refresh()[source]
class dremio_client.model.data.QueueMetadata(id=None, tag=None, name=None, cpuTier=None, maxAllowedRunningJobs=None, maxStartTimeoutMs=None)[source]

Bases: object

to_json()[source]
class dremio_client.model.data.ReflectionMetadata(entityType=None, id=None, tag=None, name=None, enabled=None, createdAt=None, updatedAt=None, type=None, datasetId=None, currentSizeBytes=None, totalSizeBytes=None, status=None, dimensionFields=None, measureFields=None, displayFields=None, distributionFields=None, partitionFields=None, sortFields=None, partitionDistributionStrategy=None)[source]

Bases: object

to_json()[source]
class dremio_client.model.data.ReflectionSummaryMetadata(entityType=None, id=None, createdAt=None, updatedAt=None, type=None, name=None, datasetId=None, datasetPath=None, datasetType=None, currentSizeBytes=None, totalSizeBytes=None, enabled=None, status=None)[source]

Bases: object

to_json()[source]
class dremio_client.model.data.Root(token=None, base_url=None, flight_endpoint=None, ssl_verify=True, dirty=False)[source]

Bases: dremio_client.model.data.Catalog

add(item)[source]
add_by_path(item, new_entity=True)[source]
class dremio_client.model.data.RootMetaData(id=None)[source]

Bases: object

to_json()[source]
class dremio_client.model.data.RuleMetadata(name=None, conditions=None, acceptId=None, acceptName=None, action=None, id=None)[source]

Bases: object

to_json()[source]
class dremio_client.model.data.Source(token=None, base_url=None, flight_endpoint=None, ssl_verify=True, dirty=False, **kwargs)[source]

Bases: dremio_client.model.data.Catalog

class dremio_client.model.data.SourceMetadata(entityType=None, id=None, name=None, description=None, tag=None, type=None, config=None, createdAt=None, metadataPolicy=None, state=None, accelerationGracePeriodMs=None, accelerationRefreshPeriodMs=None, accelerationNeverExpire=None, accelerationNeverRefresh=None, path=None, accessControlList=None)[source]

Bases: object

to_json()[source]
class dremio_client.model.data.SourceState(status=None, message=None)[source]

Bases: object

to_json()[source]
class dremio_client.model.data.Space(token=None, base_url=None, flight_endpoint=None, ssl_verify=True, dirty=False, **kwargs)[source]

Bases: dremio_client.model.data.Catalog

class dremio_client.model.data.SpaceMetaData(entityType=None, id=None, name=None, tag=None, path=None, accessControlList=None)[source]

Bases: object

to_json()[source]
class dremio_client.model.data.TagsData(tags=None, version=None)[source]

Bases: object

to_json()[source]
class dremio_client.model.data.VirtualDataset(token=None, base_url=None, flight_endpoint=None, ssl_verify=True, dirty=False, **kwargs)[source]

Bases: dremio_client.model.data.Dataset

class dremio_client.model.data.VoteMetadata(id=None, votes=None, datasetId=None, datasetPath=None, datasetType=None, datasetReflectionCount=None, entityType=None)[source]

Bases: object

to_json()[source]
class dremio_client.model.data.WikiData(text=None, version=None)[source]

Bases: object

to_json()[source]
dremio_client.model.data.create(item, token, base_url, flight_endpoint, trim_path=0, ssl_verify=True, dirty=False)[source]
dremio_client.model.data.create_folder(catalog, path)[source]
dremio_client.model.data.create_space(catalog, name)[source]
dremio_client.model.data.create_vds(catalog, path, sql, sqlContext)[source]
dremio_client.model.data.get_path(item, trim_path)[source]
dremio_client.model.data.make_reflection(data, summary=False)[source]
dremio_client.model.data.make_tags(tags)[source]
dremio_client.model.data.make_vote(vote)[source]
dremio_client.model.data.make_wiki(wiki)[source]
dremio_client.model.data.make_wlm_queue(queue)[source]
dremio_client.model.data.make_wlm_rule(rule)[source]

dremio_client.model.endpoints module

dremio_client.model.endpoints.cancel_job(token, base_url, jid, ssl_verify=True)[source]

cancel running job with job id = jid

https://docs.dremio.com/rest-api/jobs/post-job.html

Parameters:
  • token – auth token
  • base_url – sql query
  • jid – id of the job to cancel
  • ssl_verify – ignore ssl errors if False
Returns:

result object

:exception DremioNotFoundException no job found :exception DremioBadRequestException job already finished

dremio_client.model.endpoints.catalog(token, base_url, ssl_verify=True)[source]

https://docs.dremio.com/rest-api/catalog/get-catalog.html populate the root dremio catalog

Parameters:
  • token – auth token from previous login attempt
  • base_url – base Dremio url
  • ssl_verify – ignore ssl errors if False
Returns:

json of root resource
dremio_client.model.endpoints.catalog_item(token, base_url, cid=None, path=None, ssl_verify=True)[source]

fetch a specific catalog item by id or by path

https://docs.dremio.com/rest-api/catalog/get-catalog-id.html https://docs.dremio.com/rest-api/catalog/get-catalog-path.html

Parameters:
  • token – auth token from previous login attempt
  • base_url – base Dremio url
  • cid – unique dremio id for resource
  • path – list [‘space’, ‘folder’, ‘vds’]
  • ssl_verify – ignore ssl errors if False
Returns:

json of resource
dremio_client.model.endpoints.collaboration_tags(token, base_url, cid, ssl_verify=True)[source]

fetch tags for a catalog entry

https://docs.dremio.com/rest-api/user/get-catalog-collaboration.html

Parameters:
  • token – auth token
  • base_url – sql query
  • cid – id of a catalog entity
  • ssl_verify – ignore ssl errors if False
Returns:

result object
dremio_client.model.endpoints.collaboration_wiki(token, base_url, cid, ssl_verify=True)[source]

fetch wiki for a catalog entry

https://docs.dremio.com/rest-api/user/get-catalog-collaboration.html

Parameters:
  • token – auth token
  • base_url – sql query
  • cid – id of a catalog entity
  • ssl_verify – ignore ssl errors if False
Returns:

result object
dremio_client.model.endpoints.create_queue(token, base_url, json, ssl_verify=True)[source]

create a single queue

https://docs.dremio.com/rest-api/reflections/post-wlm-queue.html

Parameters:
  • token – auth token
  • base_url – sql query
  • json – json document for new queue
  • ssl_verify – ignore ssl errors if False
Returns:

result object
dremio_client.model.endpoints.create_reflection(token, base_url, json, ssl_verify=True)[source]

create a single reflection

https://docs.dremio.com/rest-api/reflections/post-reflection.html

Parameters:
  • token – auth token
  • base_url – sql query
  • json – json document for new reflection
  • ssl_verify – ignore ssl errors if False
Returns:

result object
dremio_client.model.endpoints.delete_catalog(token, base_url, cid, tag, ssl_verify=True)[source]

remove a catalog item from Dremio

https://docs.dremio.com/rest-api/catalog/delete-catalog-id.html

Parameters:
  • token – auth token
  • base_url – sql query
  • cid – id of a catalog entity
  • tag – version tag of entity
  • ssl_verify – ignore ssl errors if False
Returns:

None
dremio_client.model.endpoints.delete_personal_access_token(token, base_url, uid, tid=None, ssl_verify=True)[source]

create a pat for a given user

https://docs.dremio.com/rest-api/user/delete-user-uid-token.html

Parameters:
  • token – auth token
  • base_url – sql query
  • uid – id user
  • tid – label of token (optional)
  • ssl_verify – ignore ssl errors if False
Returns:

updated catalog entity
dremio_client.model.endpoints.delete_queue(token, base_url, queueid, ssl_verify=True)[source]

delete a single queue by id

https://docs.dremio.com/rest-api/reflections/delete-wlm-queue.html

Parameters:
  • token – auth token
  • base_url – sql query
  • queueid – id of the queue to delete
  • ssl_verify – ignore ssl errors if False
Returns:

result object
dremio_client.model.endpoints.delete_reflection(token, base_url, reflectionid, ssl_verify=True)[source]

delete a single reflection by id

https://docs.dremio.com/rest-api/reflections/delete-reflection.html

Parameters:
  • token – auth token
  • base_url – sql query
  • reflectionid – id of the reflection to delete
  • ssl_verify – ignore ssl errors if False
Returns:

result object
dremio_client.model.endpoints.graph(token, base_url, cid=None, ssl_verify=True)[source]

Retrieves graph information about a specific catalog entity by id

https://docs.dremio.com/rest-api/catalog/get-catalog-id-graph.html

Parameters:
  • token – auth token from previous login attempt
  • base_url – base Dremio url
  • cid – unique dremio id for resource
  • ssl_verify – ignore ssl errors if False
Returns:

json of resource
dremio_client.model.endpoints.group(token, base_url, gid=None, name=None, ssl_verify=True)[source]

fetch a group based on id or name

https://docs.dremio.com/rest-api/reflections/get-group.html

Parameters:
  • token – auth token
  • base_url – sql query
  • gid – unique dremio id for group
  • name – name for a group
  • ssl_verify – ignore ssl errors if False
Returns:

result object
dremio_client.model.endpoints.job_results(token, base_url, job_id, offset=0, limit=100, ssl_verify=True)[source]

fetch job results

https://docs.dremio.com/rest-api/jobs/get-job.html

Parameters:
  • token – auth token
  • base_url – sql query
  • job_id – job id (as returned by sql)
  • offset – offset of result set to return
  • limit – number of results to return (max 500)
  • ssl_verify – ignore ssl errors if False
Returns:

result object
dremio_client.model.endpoints.job_status(token, base_url, job_id, ssl_verify=True)[source]

fetch job status

https://docs.dremio.com/rest-api/jobs/get-job.html

Parameters:
  • token – auth token
  • base_url – sql query
  • job_id – job id (as returned by sql)
  • ssl_verify – ignore ssl errors if False
Returns:

status object
dremio_client.model.endpoints.modify_queue(token, base_url, queueid, json, ssl_verify=True)[source]

update a single queue by id

https://docs.dremio.com/rest-api/reflections/put-wlm-queue.html

Parameters:
  • token – auth token
  • base_url – sql query
  • queueid – id of the reflection to fetch
  • json – json document for modified queue
  • ssl_verify – ignore ssl errors if False
Returns:

result object
dremio_client.model.endpoints.modify_reflection(token, base_url, reflectionid, json, ssl_verify=True)[source]

update a single reflection by id

https://docs.dremio.com/rest-api/reflections/put-reflection.html

Parameters:
  • token – auth token
  • base_url – sql query
  • reflectionid – id of the reflection to fetch
  • json – json document for modified reflection
  • ssl_verify – ignore ssl errors if False
Returns:

result object
dremio_client.model.endpoints.modify_rules(token, base_url, json, ssl_verify=True)[source]

update wlm rules. Order of rules array is important!

The order of the rules is the order in which they will be applied. If a rule isn’t included it will be deleted new ones will be created https://docs.dremio.com/rest-api/reflections/put-wlm-rule.html

Parameters:
  • token – auth token
  • base_url – sql query
  • json – json document for modified reflection
  • ssl_verify – ignore ssl errors if False
Returns:

result object
dremio_client.model.endpoints.personal_access_token(token, base_url, uid, ssl_verify=True)[source]

fetch a PAT for a user based on id

https://docs.dremio.com/rest-api/user/get-user-id-token.html

Parameters:
  • token – auth token
  • base_url – sql query
  • uid – id of a user
  • ssl_verify – ignore ssl errors if False
Returns:

result object
dremio_client.model.endpoints.promote_catalog(token, base_url, cid, json, ssl_verify=True)[source]

promote a catalog entity (only works on folders and files in sources

https://docs.dremio.com/rest-api/catalog/post-catalog-id.html

Parameters:
  • token – auth token
  • base_url – sql query
  • cid – id of catalog entity
  • json – json document for new catalog entity
  • ssl_verify – ignore ssl errors if False
Returns:

updated catalog entity
dremio_client.model.endpoints.reflection(token, base_url, reflectionid, ssl_verify=True)[source]

fetch a single reflection by id

https://docs.dremio.com/rest-api/reflections/get-reflection.html

Parameters:
  • token – auth token
  • base_url – sql query
  • reflectionid – id of the reflection to fetch
  • ssl_verify – ignore ssl errors if False
Returns:

result object
dremio_client.model.endpoints.reflections(token, base_url, summary=False, ssl_verify=True)[source]

fetch all reflections

https://docs.dremio.com/rest-api/reflections/get-reflection.html

Parameters:
  • token – auth token
  • base_url – sql query
  • summary – fetch only the reflection summary
  • ssl_verify – ignore ssl errors if False
Returns:

result object
dremio_client.model.endpoints.refresh_pds(token, base_url, pid, ssl_verify=True)[source]

refresh a physical dataset and all its child reflections

https://docs.dremio.com/rest-api/catalog/post-catalog-id-refresh.html

Parameters:
  • token – auth token
  • base_url – sql query
  • pid – id of a catalog entity
  • ssl_verify – ignore ssl errors if False
Returns:

None
dremio_client.model.endpoints.set_catalog(token, base_url, json, ssl_verify=True)[source]

add a new catalog entity

https://docs.dremio.com/rest-api/catalog/post-catalog.html

Parameters:
  • token – auth token
  • base_url – sql query
  • json – json document for new catalog entity
  • ssl_verify – ignore ssl errors if False
Returns:

new catalog entity
dremio_client.model.endpoints.set_collaboration_tags(token, base_url, cid, tags, ssl_verify=True)[source]

set tags on a given catalog entity

https://docs.dremio.com/rest-api/catalog/post-catalog-collaboration.html

Parameters:
  • token – auth token
  • base_url – sql query
  • cid – id of a catalog entity
  • tags – list of strings for tags
  • ssl_verify – ignore ssl errors if False
Returns:

None
dremio_client.model.endpoints.set_collaboration_wiki(token, base_url, cid, wiki, ssl_verify=True)[source]

set wiki on a given catalog entity

https://docs.dremio.com/rest-api/catalog/post-catalog-collaboration.html

Parameters:
  • token – auth token
  • base_url – sql query
  • cid – id of a catalog entity
  • wiki – text representing markdown for entity
  • ssl_verify – ignore ssl errors if False
Returns:

None
dremio_client.model.endpoints.set_personal_access_token(token, base_url, uid, label, lifetime=24, ssl_verify=True)[source]

create a pat for a given user

https://docs.dremio.com/rest-api/user/post-user-uid-token.html

Parameters:
  • token – auth token
  • base_url – sql query
  • uid – id user
  • label – label of token
  • lifetime – lifetime in hours of token
  • ssl_verify – ignore ssl errors if False
Returns:

updated catalog entity
dremio_client.model.endpoints.sql(token, base_url, query, context=None, ssl_verify=True)[source]

submit job w/ given sql

https://docs.dremio.com/rest-api/sql/post-sql.html

Parameters:
  • token – auth token
  • base_url – base Dremio url
  • query – sql query
  • context – optional dremio context
  • ssl_verify – ignore ssl errors if False
Returns:

job id json object
dremio_client.model.endpoints.update_catalog(token, base_url, cid, json, ssl_verify=True)[source]

update a catalog entity

https://docs.dremio.com/rest-api/catalog/put-catalog-id.html

Parameters:
  • token – auth token
  • base_url – sql query
  • cid – id of catalog entity
  • json – json document for new catalog entity
  • ssl_verify – ignore ssl errors if False
Returns:

updated catalog entity
dremio_client.model.endpoints.user(token, base_url, uid=None, name=None, ssl_verify=True)[source]

fetch user based on id or name https://docs.dremio.com/rest-api/reflections/get-user.html

Parameters:
  • token – auth token
  • base_url – sql query
  • uid – unique dremio id for user
  • name – name for a user
  • ssl_verify – ignore ssl errors if False
Returns:

result object
dremio_client.model.endpoints.votes(token, base_url, ssl_verify=True)[source]

fetch all votes

https://docs.dremio.com/rest-api/reflections/get-vote.html

Parameters:
  • token – auth token
  • base_url – sql query
  • ssl_verify – ignore ssl errors if False
Returns:

result object
dremio_client.model.endpoints.wlm_queues(token, base_url, ssl_verify=True)[source]

fetch all wlm queues

https://docs.dremio.com/rest-api/reflections/get-wlm-queue.html

Parameters:
  • token – auth token
  • base_url – sql query
  • ssl_verify – ignore ssl errors if False
Returns:

result object
dremio_client.model.endpoints.wlm_rules(token, base_url, ssl_verify=True)[source]

fetch all wlm rules

https://docs.dremio.com/rest-api/reflections/get-wlm-queue.html

Parameters:
  • token – auth token
  • base_url – sql query
  • ssl_verify – ignore ssl errors if False
Returns:

result object

Module contents