SETL 1.0.0-RC2 API - io.github.setl.storage.connector

abstract class ACIDConnector extends Connector with CanUpdate with CanDrop with CanDelete with CanVacuum

Annotations: @Evolving()

class CSVConnector extends FileConnector

Connector that loads CSV files and returns the result as a DataFrame.

You can set the following CSV-specific options to deal with CSV files:

sep (default ,): sets a single character as a separator for each field and value.
encoding (default UTF-8): decodes the CSV files by the given encoding type.
quote (default "): sets a single character used for escaping quoted values where the separator can be part of the value. If you would like to turn off quotations, you need to set not null but an empty string. This behaviour is different from com.databricks.spark.csv.
escape (default \): sets a single character used for escaping quotes inside an already quoted value.
charToEscapeQuoteEscaping (default escape or \0): sets a single character used for escaping the escape for the quote character. The default value is escape character when escape and quote characters are different, \0 otherwise.
comment (default empty string): sets a single character used for skipping lines beginning with this character. By default, it is disabled.
header (default false): uses the first line as names of columns.
enforceSchema (default true): If it is set to true, the specified or inferred schema will be forcibly applied to datasource files, and headers in CSV files will be ignored. If the option is set to false, the schema will be validated against all headers in CSV files in the case when the header option is set to true. Field names in the schema and column names in CSV headers are checked by their positions taking into account spark.sql.caseSensitive. Though the default value is true, it is recommended to disable the enforceSchema option to avoid incorrect results.
inferSchema (default false): infers the input schema automatically from data. It requires one extra pass over the data.
samplingRatio (default is 1.0): defines fraction of rows used for schema inferring.
ignoreLeadingWhiteSpace (default false): a flag indicating whether or not leading whitespaces from values being read should be skipped.
ignoreTrailingWhiteSpace (default false): a flag indicating whether or not trailing whitespaces from values being read should be skipped.
nullValue (default empty string): sets the string representation of a null value. Since 2.0.1, this applies to all supported types including the string type.
emptyValue (default empty string): sets the string representation of an empty value.
nanValue (default NaN): sets the string representation of a non-number" value.
positiveInf (default Inf): sets the string representation of a positive infinity value.
negativeInf (default -Inf): sets the string representation of a negative infinity value.
dateFormat (default yyyy-MM-dd): sets the string that indicates a date format. Custom date formats follow the formats at java.text.SimpleDateFormat. This applies to date type.
timestampFormat (default yyyy-MM-dd'T'HH:mm:ss.SSSXXX): sets the string that indicates a timestamp format. Custom date formats follow the formats at java.text.SimpleDateFormat. This applies to timestamp type.
maxColumns (default 20480): defines a hard limit of how many columns a record can have.
maxCharsPerColumn (default -1): defines the maximum number of characters allowed for any given value being read. By default, it is -1 meaning unlimited length
mode (default PERMISSIVE): allows a mode for dealing with corrupt records during parsing. It supports the following case-insensitive modes.
PERMISSIVE : when it meets a corrupted record, puts the malformed string into a field configured by columnNameOfCorruptRecord, and sets other fields to null. To keep corrupt records, an user can set a string type field named columnNameOfCorruptRecord in an user-defined schema. If a schema does not have the field, it drops corrupt records during parsing. A record with less/more tokens than schema is not a corrupted record to CSV. When it meets a record having fewer tokens than the length of the schema, sets null to extra fields. When the record has more tokens than the length of the schema, it drops extra tokens.
DROPMALFORMED : ignores the whole corrupted records.
FAILFAST : throws an exception when it meets corrupted records.
columnNameOfCorruptRecord (default is the value specified in spark.sql.columnNameOfCorruptRecord): allows renaming the new field having malformed string created by PERMISSIVE mode. This overrides spark.sql.columnNameOfCorruptRecord.
multiLine (default false): parse one record, which may span multiple lines.

Annotations: @Evolving()

class CassandraConnector extends DBConnector with HasReaderWriter

CassandraConnector establish the connection to a given cassandra table of a given keyspace

Annotations: @Evolving()

trait Connector extends HasSparkSession with Logging

Connector is a non-typed data access layer (DAL) abstraction that provides read/write functionalities.

A basic data storage connector has two main functionalities:

Read data from the persistence store
Write data into the persistence store

Annotations: @Evolving()

trait ConnectorInterface extends Connector

ConnectorInterface provides the abstraction of a pluggable connector that could be used by io.github.setl.storage.ConnectorBuilder.

ConnectorInterface provides the abstraction of a pluggable connector that could be used by io.github.setl.storage.ConnectorBuilder. Users can implement their customized data source connector by extending this trait.

abstract class DBConnector extends Connector with CanCreate with CanDrop with CanDelete

Annotations: @Evolving()

class DeltaConnector extends ACIDConnector with HasReaderWriter with CanPartition

DeltaConnector contains functionality for transforming DataFrame into DeltaLake files

class DynamoDBConnector extends DBConnector with HasReaderWriter

DynamoDB connector.

# Configuration
dynamodb {
  region = ""
  table = ""
  saveMode = ""
}

Annotations: @Evolving()

class ExcelConnector extends Connector with HasReaderWriter

ExcelConnector contains functionality for transforming DataFrame into parquet files

Annotations: @Evolving()

abstract class FileConnector extends Connector with HasReaderWriter with CanDrop with CanPartition

Annotations: @Evolving()

class JDBCConnector extends DBConnector with HasReaderWriter

class JSONConnector extends FileConnector

Connector that loads JSON files and returns the results as a DataFrame.

You can set the following JSON-specific options to deal with non-standard JSON files:

primitivesAsString (default false): infers all primitive values as a string type
prefersDecimal (default false): infers all floating-point values as a decimal type. If the values do not fit in decimal, then it infers them as doubles.
allowComments (default false): ignores Java/C++ style comment in JSON records
allowUnquotedFieldNames (default false): allows unquoted JSON field names
allowSingleQuotes (default true): allows single quotes in addition to double quotes
allowNumericLeadingZeros (default false): allows leading zeros in numbers (e.g. 00012)
allowBackslashEscapingAnyCharacter (default false): allows accepting quoting of all character using backslash quoting mechanism
allowUnquotedControlChars (default false): allows JSON Strings to contain unquoted control characters (ASCII characters with value less than 32, including tab and line feed characters) or not.
mode (default PERMISSIVE): allows a mode for dealing with corrupt records during parsing.
PERMISSIVE : when it meets a corrupted record, puts the malformed string into a field configured by columnNameOfCorruptRecord, and sets other fields to null. To keep corrupt records, an user can set a string type field named columnNameOfCorruptRecord in an user-defined schema. If a schema does not have the field, it drops corrupt records during parsing. When inferring a schema, it implicitly adds a columnNameOfCorruptRecord field in an output schema.
DROPMALFORMED : ignores the whole corrupted records.
FAILFAST : throws an exception when it meets corrupted records.
columnNameOfCorruptRecord (default is the value specified in spark.sql.columnNameOfCorruptRecord): allows renaming the new field having malformed string created by PERMISSIVE mode. This overrides spark.sql.columnNameOfCorruptRecord.
dateFormat (default yyyy-MM-dd): sets the string that indicates a date format. Custom date formats follow the formats at java.text.SimpleDateFormat. This applies to date type.
timestampFormat (default yyyy-MM-dd'T'HH:mm:ss.SSSXXX): sets the string that indicates a timestamp format. Custom date formats follow the formats at java.text.SimpleDateFormat. This applies to timestamp type.
multiLine (default false): parse one record, which may span multiple lines, per file
encoding (by default it is not set): allows to forcibly set one of standard basic or extended encoding for the JSON files. For example UTF-16BE, UTF-32LE. If the encoding is not specified and multiLine is set to true, it will be detected automatically.
lineSep (default covers all \r, \r\n and \n): defines the line separator that should be used for parsing.
samplingRatio (default is 1.0): defines fraction of input JSON objects used for schema inferring.
dropFieldIfAllNull (default false): whether to ignore column of all null values or empty array/struct during schema inference.

Annotations: @Evolving()

class ParquetConnector extends FileConnector

ParquetConnector contains functionality for transforming DataFrame into parquet files

Annotations: @Evolving()

abstract class StreamingConnector extends Connector with CanWait

class StructuredStreamingConnector extends StreamingConnector

:: Experimental ::

Spark Structured Streaming connector

Annotations: @Experimental() @Unstable()

Packages

connector

package connector

Type Members

Value Members

Ungrouped