pycarol.connectors

class pycarol.connectors.Connectors(carol)

This class handle all APIs related to Carol connectors

Parameters

carol – class: pycarol.Carol

create(name, label=None, group_name='Others', overwrite=False)

Create a connector

Parameters

• name – ‘str’ Connector name

• label – ‘str’ Connector label in UI

• group_name – str default “Others” Connector group name in UI

• overwrite – bool default False Overwrite if already exists.

delete_by_id(connector_id=None, mdm_id=None, force_deletion=True)

Delete Connector by ID

Parameters

• connector_id – str` Connector ID

• mdm_id – str` Connector ID

• force_deletion – bool default True Force the deletion

Returns: None

delete_by_name(name, force_deletion=True)

Delete connector by name

Parameters

• name – str Connector name

• force_deletion – bool default True Force the deletion

Returns: None

find_by_staging(staging_name=None)

Find connector given a staging table

Parameters

staging_name – str default None Staging table name

Returns: dict

Connector information

get_all(offset=0, page_size=-1, sort_order='ASC', sort_by=None, include_connectors=False, include_mappings=False, include_consumption=False, print_status=True, save_results=False, filename='connectors.json')

Get all connectors.

Parameters

• offset – int, default 0 Offset for the response.

• page_size – int, default 1000 Number of records in each call.

• sort_by – str default None Field to sort by

• sort_order – str, default ASC Sort Order. Possible values “ASC” and “DESC”

• include_connectors – bool default False Include connector information

• include_mappings – bool default False Include mapping information

• include_consumption – bool default False Include consumption information

• print_status – bool default True Print status of the request.

• save_results – bool default False If save json with the results.

• filename – str default None Filename to save

Returns: dict

Connector information

get_all_stagings(connector_name=None, connector_id=None)

Get all stagings from a connector.

Parameters

• connector_name – str, str, default None Connector Name

• connector_id – str, str, default None Connector ID

Returns: list

List of staging tables.

get_by_id(id, errors='raise')

Get connector information using the connector name

Parameters

• id – ‘str’ Connector ID

• errors – {‘ignore’, ‘raise’}, default ‘raise’ If ‘raise’, then invalid request will raise an exception If ‘ignore’, then invalid request will return the request response

Returns: dict

connector information.

get_by_name(name, errors='raise')

Get connector information using the connector name

Parameters

• name – ‘str’ Connector Name

• errors – {‘ignore’, ‘raise’}, default ‘raise’ If ‘raise’, then invalid request will raise an exception If ‘ignore’, then invalid request will return the request response

Returns: dict

connector information.

staging_to_connectors_map()

Create a dictionary where the mapping of connectors and stagings.

Returns: dict

Dict

stats(connector_id=None, connector_name=None, all_connectors=False)

Get connector stats

Parameters

• connector_id – str, default None Connector Id

• connector_name – str, default None Connectot name

• all_connectors – bool default False Get from all connectors.

Returns: dict

Dict with the status of the connectors.