saola_connector

DataModelSaolaConnector

DataModelSaolaConnector(data_model, use_api_v2=False)

Bases: SaolaConnector

Data model saola connector.

data_model instance-attribute

data_model = data_model

verify_query

verify_query(query)

Verifies given query.

convert_filter_to_expressions

convert_filter_to_expressions(filter_)

Converts given pql filter to conditional expressions.

Parameters:

• filter_ (PQLFilter) –

  PQL filter to convert.

Returns:

• List[str] –

  Conditional expressions resulting from pql filter.

KnowledgeModelSaolaConnector

KnowledgeModelSaolaConnector(
    data_model, knowledge_model, draft=True
)

Bases: SaolaConnector

Knowledge model saola connector.

Parameters:

• data_model (DataModel) –

  Data model to use within the connector

• knowledge_model (KnowledgeModel) –

  Knowledge model to use within the connector

• draft (bool, default: True ) –

  If true, uses draft of knowledge model for data exports, if false uses published version.

data_model instance-attribute

data_model = data_model

knowledge_model instance-attribute

knowledge_model = knowledge_model

draft instance-attribute

draft = draft

verify_query

verify_query(query)

Verifies given query.

convert_filter_to_expressions

convert_filter_to_expressions(filter_)

Converts given pql filter to conditional expressions.

Parameters:

• filter_ (PQLFilter) –

  PQL filter to convert.

Returns:

• List[str] –

  Conditional expressions resulting from pql filter.

AnalysisSaolaConnector

AnalysisSaolaConnector(
    data_model, analysis, use_api_v2=False
)

Bases: SaolaConnector

Analysis saola connector.

Warning

The class AnalysisSaolaConnector has been deprecated and will be removed in future versions. Please use KnowledgeModelConnector from now on to export data You can refer from tutorial Pulling Data from an Analysis.

data_model instance-attribute

data_model = data_model

analysis instance-attribute

analysis = analysis

verify_query

verify_query(query)

Verifies given query.

convert_filter_to_expressions

convert_filter_to_expressions(filter_)

Converts given pql filter to conditional expressions.

Parameters:

• filter_ (PQLFilter) –

  PQL filter to convert.

Returns:

• List[str] –

  Conditional expressions resulting from pql filter.

verify_columns

verify_columns(data_model, columns)

Verifies given columns.

verify_filters

verify_filters(data_model, filters)

Verifies given filters.