abacusai.feature_group_export

Module Contents

Classes

FeatureGroupExport

A feature Group Export Job

class abacusai.feature_group_export.FeatureGroupExport(client, featureGroupExportId=None, featureGroupVersion=None, connectorType=None, outputLocation=None, fileFormat=None, databaseConnectorId=None, objectName=None, writeMode=None, databaseFeatureMapping=None, idColumn=None, status=None, createdAt=None, exportCompletedAt=None, additionalIdColumns=None, error=None, databaseOutputError=None)

Bases: abacusai.return_class.AbstractApiClass

A feature Group Export Job

Parameters:
  • client (ApiClient) – An authenticated API Client instance

  • featureGroupExportId (str) – The unique identifier for this export

  • featureGroupVersion (str) – The version of the feature group being exported

  • connectorType (str) – Either DATABASE_CONNECTOR or FILE_CONNECTOR

  • outputLocation (str) – The File Connector location the feature group is being written to

  • fileFormat (str) – The file format being written to outputLocation

  • databaseConnectorId (str) – The database connector ID used

  • objectName (str) – The database connector’s object to write to

  • writeMode (str) – UPSERT or INSERT for writing to the database connector

  • databaseFeatureMapping (dict) – The column/feature pairs mapping the features to the database columns

  • idColumn (str) – The id column to use as the upsert key

  • status (str) – The current status of the export.

  • createdAt (str) – The timestamp at which the export was created.

  • exportCompletedAt (str) – The timestamp at which the export completed

  • additionalIdColumns (list of string) – For database connectors which support it, additional ID columns to use as a complex key for upserting

  • error (str) – If status is FAILED, this field will be populated with an error.

  • databaseOutputError (bool) – If true, there were errors reported by the database connector while writing

__repr__()

Return repr(self).

to_dict()

Get a dict representation of the parameters in this class

Returns:

The dict value representation of the class parameters

Return type:

dict

get_feature_group_version_export_download_url()

Get a link to download the feature group version.

Parameters:

feature_group_export_id (str) – The Feature Group Export to get signed url for.

Returns:

The FeatureGroupExportDownloadUrl instance, which contains the download URL and expiration time.

Return type:

FeatureGroupExportDownloadUrl

refresh()

Calls describe and refreshes the current object’s fields

Returns:

The current object

Return type:

FeatureGroupExport

describe()

A feature group export

Parameters:

feature_group_export_id (str) – The ID of the feature group export.

Returns:

The feature group export

Return type:

FeatureGroupExport

get_connector_errors()

Returns a stream containing the feature group export database connection write errors, if any writes failed to the database connector

Parameters:

feature_group_export_id (str) – The ID of the feature group export to get the errors for

wait_for_results(timeout=3600)

A waiting call until feature group export is created.

Parameters:

timeout (int, optional) – The waiting time given to the call to finish, if it doesn’t finish by the allocated time, the call is said to be timed out.

get_status()

Gets the status of the feature group export.

Returns:

A string describing the status of a feature group export (pending, complete, etc.).

Return type:

str

get_results()