Cognite extractor-utils package
The extractor-utils package is an extension of the Cognite Python SDK intended to simplify the development of data extractors for Cognite Data Fusion.
Installation
To install this package:
pip install cognite-extractor-utils
If the Cognite SDK is not already installed, the installation will automatically fetch and install it as well.
To get going, consult the Quickstart
Contents
- Quickstart
- Remote configuration
- Package reference
- Base class for extractors
configtools
- Utilities for reading, parsing and validating config filesmetrics
- Automatic pushers of performance metricsstatestore
- Storing extractor state between runs locally or remotelyAbstractHashStateStore
AbstractStateStore
AbstractStateStore.delete_state()
AbstractStateStore.expand_state()
AbstractStateStore.get_state()
AbstractStateStore.initialize()
AbstractStateStore.outside_state()
AbstractStateStore.post_upload_handler()
AbstractStateStore.set_state()
AbstractStateStore.start()
AbstractStateStore.stop()
AbstractStateStore.synchronize()
LocalHashStateStore
LocalStateStore
NoStateStore
RawHashStateStore
RawStateStore
uploader
- Batching upload queues with automatic upload triggersutil
- Miscellaneous utilitiesBufferedReadWithLength
BufferedReadWithLength.close()
BufferedReadWithLength.closed
BufferedReadWithLength.detach()
BufferedReadWithLength.fileno()
BufferedReadWithLength.flush()
BufferedReadWithLength.isatty()
BufferedReadWithLength.mode
BufferedReadWithLength.name
BufferedReadWithLength.peek()
BufferedReadWithLength.raw
BufferedReadWithLength.read()
BufferedReadWithLength.read1()
BufferedReadWithLength.readable()
BufferedReadWithLength.readinto()
BufferedReadWithLength.readinto1()
BufferedReadWithLength.readline()
BufferedReadWithLength.readlines()
BufferedReadWithLength.seek()
BufferedReadWithLength.seekable()
BufferedReadWithLength.tell()
BufferedReadWithLength.truncate()
BufferedReadWithLength.writable()
BufferedReadWithLength.write()
BufferedReadWithLength.writelines()
EitherId
add_extraction_pipeline()
cognite_exceptions()
datetime_to_timestamp()
ensure_assets()
ensure_time_series()
httpx_exceptions()
iterable_to_stream()
now()
requests_exceptions()
retry()
throttled_loop()
timestamp_to_datetime()
truncate_byte_len()