ayx_python_sdk.providers.e1_provider.records package¶

Submodules¶

ayx_python_sdk.providers.e1_provider.records.base_record_container module¶

BaseRecordContainer class definition.

class ayx_python_sdk.providers.e1_provider.records.base_record_container.BaseRecordContainer[source]¶

Bases: abc.ABC

Container for records.

abstract add_record(record: RecordRef) → None [source]¶: Make a copy of the record and add it to the container.

abstract build_dataframe() → pd.DataFrame[source]¶: Build a dataframe from the records.

clear_records() → None [source]¶: Clear all accumulated records.

records¶

abstract update_with_dataframe(df: pd.DataFrame) → None [source]¶: Update container with a dataframe.

ayx_python_sdk.providers.e1_provider.records.parsed_record_container module¶

ParsedRecordContainer class definition.

class ayx_python_sdk.providers.e1_provider.records.parsed_record_container.ParsedRecordContainer(input_record_info: AlteryxPythonSDK.RecordInfo, field_names_to_parse: Optional[List[str]] = None)[source]¶

Bases: ayx_python_sdk.providers.e1_provider.records.base_record_container.BaseRecordContainer

Container for parsing and holding parsed records.

add_record(record: AlteryxPythonSDK.RecordRef) → None [source]¶: Add a new record to the container and parse it.

build_dataframe() → pd.DataFrame[source]¶: Build a dataframe out of the parsed records.

records¶

update_with_dataframe(df: pd.DataFrame) → None [source]¶: Update container with a dataframe.

ayx_python_sdk.providers.e1_provider.records.raw_record_container module¶

RawRecordContainer class definition.

class ayx_python_sdk.providers.e1_provider.records.raw_record_container.RawRecordContainer(input_record_info: AlteryxPythonSDK.RecordInfo, storage_record_info: Optional[AlteryxPythonSDK.RecordInfo] = None, field_map: Optional[Dict[str, str]] = None)[source]¶

Bases: ayx_python_sdk.providers.e1_provider.records.base_record_container.BaseRecordContainer

Container for copying and holding raw records.

add_record(record: AlteryxPythonSDK.RecordRef) → None [source]¶: Make a copy of the record and add it to the container.

build_dataframe() → pd.DataFrame[source]¶: Build a dataframe from the container.

records¶

update_with_dataframe(df: pd.DataFrame) → None [source]¶: Update stored records with values from a dataframe.

Module contents¶

Record class definitions.

class ayx_python_sdk.providers.e1_provider.records.BaseRecordContainer[source]¶

Bases: abc.ABC

Container for records.

abstract add_record(record: RecordRef) → None [source]¶: Make a copy of the record and add it to the container.

abstract build_dataframe() → pd.DataFrame[source]¶: Build a dataframe from the records.

clear_records() → None [source]¶: Clear all accumulated records.

records¶

abstract update_with_dataframe(df: pd.DataFrame) → None [source]¶: Update container with a dataframe.

class ayx_python_sdk.providers.e1_provider.records.ParsedRecordContainer(input_record_info: AlteryxPythonSDK.RecordInfo, field_names_to_parse: Optional[List[str]] = None)[source]¶

Bases: ayx_python_sdk.providers.e1_provider.records.base_record_container.BaseRecordContainer

Container for parsing and holding parsed records.

add_record(record: AlteryxPythonSDK.RecordRef) → None [source]¶: Add a new record to the container and parse it.

build_dataframe() → pd.DataFrame[source]¶: Build a dataframe out of the parsed records.

records¶

update_with_dataframe(df: pd.DataFrame) → None [source]¶: Update container with a dataframe.

class ayx_python_sdk.providers.e1_provider.records.RawRecordContainer(input_record_info: AlteryxPythonSDK.RecordInfo, storage_record_info: Optional[AlteryxPythonSDK.RecordInfo] = None, field_map: Optional[Dict[str, str]] = None)[source]¶

Bases: ayx_python_sdk.providers.e1_provider.records.base_record_container.BaseRecordContainer

Container for copying and holding raw records.

add_record(record: AlteryxPythonSDK.RecordRef) → None [source]¶: Make a copy of the record and add it to the container.

build_dataframe() → pd.DataFrame[source]¶: Build a dataframe from the container.

records¶

update_with_dataframe(df: pd.DataFrame) → None [source]¶: Update stored records with values from a dataframe.