Skip to content

Basic Functions

Basic

OmixAtlas class enables users to interact with functional properties of the omixatlas such as create and update an Omixatlas, get summary of it's contents, add, insert, update the schema, add, update or delete datasets, query metadata, download data, save data to workspace etc.

Parameters:

Name Type Description Default
token str

token copy from polly.

required
Usage

from polly.OmixAtlas import OmixAtlas omixatlas = OmixAtlas(token)

create(display_name, description, repo_name='', image_url='', components=[])

This function is used to create a new omixatlas.

Parameters:

Name Type Description Default
display_name str

Display name of the omixatlas as shown on the GUI.

required
description str

description of the omixatlas.

required
repo_name str

repo_name which is used to create index in database.

''
image_url str

URL of the image which should be kept as the icon for omixatlas.

''
initials str

Initials shown in the icon of omixatlas.

required
explorer_enabled bool

Default True.

required
studio_presets list

Optional Paramter.

required
components list

Optional Parameter.

[]

Returns:

Type Description
pd.DataFrame

Dataframe after creation of omixatlas.

Raises:

Type Description
ValueError

Repository creation response is in Incorrect format.

get_all_omixatlas(query_api_version='v2', count_by_source=True, count_by_data_type=True)

This function will return the summary of all the Omixatlas on Polly which the user has access to.

Returns:

Type Description

It will return a list of JSON objects. (See Examples)

omixatlas_summary(repo_key, query_api_version='v2', count_by_source=True, count_by_data_type=True)

This function will return you a object that contain summary of a given Omixatlas.

Parameters:

Name Type Description Default
repo_key str/int

repo_key(repo_name/repo_id)

required

Returns:

Type Description

It will return a JSON object. (see examples)

update(repo_key, display_name='', description='', image_url='', components=[])

This function is used to update an omixatlas. Args: display_name (str, optional): Display name of the omixatlas as shown on the GUI. description (str, optional): Description of the omixatlas. image_url (str, optional): URL of the image which should be kept as the icon for omixatlas. components (list, optional): List of components to be added.