SourceClient
class SourceClient(lightctl.client.base_client.BaseClient)
| Helper functions for acessing datasources
|
| Example:
| sc = SourceClient()
| datasource_list = list_sources()
| for datasource in datasource_list:
| print("Datasource {datasource["name"]})
|
| Methods defined here:
|
| activate_column(self, workspace_id: str, id: uuid.UUID, table_id: uuid.UUID, column_id: uuid.UUID, enable: bool = True)
|
| activate_schema(self, workspace_id: str, id: uuid.UUID, schema_id: uuid.UUID, enable: bool = True)
|
| activate_source(self, workspace_id: str, id: uuid.UUID, enable: bool = True)
|
| activate_table(self, workspace_id: str, id: uuid.UUID, table_id: uuid.UUID, enable: bool = True)
|
| create_source(self, workspace_id: str, data: Dict) -> Dict
| Create a datasource
|
| Args:
| workspace_id (str): Workspace id
| data (dict) attributes of datasource
|
| Returns:
| dict: the datasource created
|
| delete_source(self, workspace_id: str, id: uuid.UUID) -> Dict
| Delete a datasource
|
| Args:
| workspace_id (str): Workspace id
| id (UUID): id of datasource to delete
|
| get_column(self, workspace_id: str, id: uuid.UUID, table_id: uuid.UUID, column_id: uuid.UUID) -> Dict
| Get a column from its column_id
|
| Args:
| workspace_id (str): Workspace id
| id (UUID): Datasource id
| table_id (UUID): Table id
| column_id (UUID): Column id
|
| Returns:
| dict: a column
|
| get_schema(self, workspace_id: str, id: uuid.UUID, schema_id: uuid.UUID) -> Dict
| Get a schema from its schema id
|
| Args:
| workspace_id (str): Workspace id
| id (UUID): Datasource id
| schema_id (UUID): Schema id
|
| Returns:
| dict: a schema
|
| get_source(self, workspace_id: str, id: uuid.UUID) -> Dict
| Get a datasources by its uuid
|
| Args:
| workspace_id (str): Workspace id
| id (UUID): id of datasource to return
|
| Returns:
| dict: a datasource
|
| get_source_by_name(self, workspace_id: str, name: str) -> List[Dict]
| Get a datasource by its name
|
| Args:
| workspace_id (str): Workspace id
| name (str): name of datasource to return
|
| Returns:
| dict: a datasource
|
| get_table(self, workspace_id: str, id: uuid.UUID, table_id: uuid.UUID) -> Dict
| Get a table from its table id
|
| Args:
| workspace_id (str): Workspace id
| id (UUID): Datasource id
| table_id (UUID): Table id
|
| Returns:
| dict: a table
|
| get_table_schema(self, workspace_id: str, id: uuid.UUID, table_name: str) -> Dict
| Get a table's schema by table name
|
| Args:
| workspace_id (str): Workspace id
| id (UUID): Datasource id
| table_name (UUID): Table name
|
| Returns:
| dict: a schema
|
| inspect(self, workspace_id: str, data: Dict) -> Dict
|
| list_columns(self, workspace_id: str, id: uuid.UUID, table_id: uuid.UUID) -> List[Dict]
| Get all columns in a table
|
| Args:
| workspace_id (str): Workspace id
| id (UUID): Datasource id
| table_id (UUID): Table id
|
| Returns:
| list: a list of tables
|
| list_schemas(self, workspace_id: str, id: uuid.UUID) -> List[Dict]
| Get all schemas in the datasource
|
| Args:
| workspace_id (str): Workspace id
| id (UUID): Datasource id
|
| Returns:
| list: a list of schemas
|
| list_sources(self, workspace_id: str) -> List[Dict]
| Get all datasources in the workspace
|
| Args:
| workspace_id (str): Workspace id
|
| Returns:
| list: a list of datasources
|
| list_tables(self, workspace_id: str, id: uuid.UUID) -> List[Dict]
| Get all tables in a datasource
|
| Args:
| workspace_id (str): Workspace id
| id (UUID): Datasource id
|
| Returns:
| list: a list of tables
|
| sources_url(self, workspace_id: str) -> str
| Returns:
| str: The datasources endpoint, used for getting and modifying datasources
|
| trigger_source(self, workspace_id: str, id: uuid.UUID, data: Dict) -> Dict
| Trigger data collection on all triggered metrics in a datasource
|
| Args:
| workspace_id (str): Workspace id
| id (UUID): Datasource id
|
| update_profiler_config(self, workspace_id: str, id: uuid.UUID, table_uuid: str, data: Dict) -> Dict
| Update configuration for a table in a datasource
|
| Args:
| workspace_id (str): Workspace id
| id (UUID): id of datasource
| table_id (UUID): id of table
| data (dict) new table configuration
|
| update_source(self, workspace_id: str, id: uuid.UUID, data: Dict) -> Dict
| Update a datasource
|
| Args:
| workspace_id (str): Workspace id
| id (UUID): id of datasource to update
| data (dict) new attributes of the datasource
|
| Returns:
| dict: the datasource updated
|
Updated 12 months ago