singer_sdk.contrib.filesystem.tap.FolderTap

class singer_sdk.contrib.filesystem.tap.FolderTap

Singer tap for files in a directory.

classmethod append_builtin_config(config_jsonschema)

Appends built-in config to config_jsonschema if not already set.

To customize or disable this behavior, developers may either override this class method or override the capabilities property to disabled any unwanted built-in capabilities.

For all except very advanced use cases, we recommend leaving these implementations “as-is”, since this provides the most choice to users and is the most “future proof” in terms of taking advantage of built-in capabilities which may be added in the future.

Parameters:

config_jsonschema (dict) – [description]

Return type:

None

discover_streams()

Return a list of discovered streams.

Raises:

ValueError – If the path does not exist or is not a directory.

Return type:

list

default_stream_class: type[_T]

The default stream class to use for this tap.

This should be a subclass of FileStream.

dynamic_catalog: bool = True

Whether the tap’s catalog is dynamic. Set to True if the catalog is generated dynamically (e.g. by querying a database’s system tables).

property fs: AbstractFileSystem

Return the filesystem object.

Raises:

ConfigValidationError – If the filesystem configuration is missing.

property path: str

Return the path to the directory.

property read_mode: ReadMode

Folder read mode.

valid_extensions: tuple[str, ...]

Valid file extensions for this tap.

Files with extensions not in this list will be ignored.