Home Schema Example JSON Schema

TabularInferface Settings

Type: object

These settings are used by providers that depend on scalpel.externals.TabularInterfaces.

No Additional Properties

Tabular Interface

Type: object

Settings for using scalpel.externals.TabularInterface. When this key is used, TabularInterface.from_url(...) is used to load the source data.

Type: object

The following properties are required:

  • url
Type: object

The following properties are required:

  • urls

URL

Type: string

The URL containing tabular data.

Must be at least 1 characters long

URLs

Type: array of string

URLs containing tabular data (for use when data is split into multiple tables).

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

Type: string

Must be at least 1 characters long

Sheet Name

Type: string

Name of the sheet in a workbook

Must be at least 1 characters long

Status Column

Type: string

Used to denote which is the Status column. Defaults to Status.

If any of development, staging, production, test appears in the status column, the row will be ignored unless it is executed in the same environment (as denoted by settings.ENVIRONMENT).

If ignore appears in the status column, the row is ignored.

Must be at least 1 characters long

Headers

Type: array of string

An array of string to denote the headers for the TabularInterface. Useful if the source data does not define headers.

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

Type: string

Must be at least 1 characters long

Skip Header Row

Type: boolean

Whether to skip the header row.

This is a misnomer. It refers to whether the source data contains a header row.

When set to true, every row of the source data is read.

When set to false (default behavior), the first row of the data is treated as the headers value and data starts from the 2nd row onwards.

Each additional property must conform to the following schema

Type: object

Additional properties will be passed on to the __init__ for the TabularInterface reader.

Airtable

Type: object

Settings for using scalpel.externals.Airtable.

Type: object

The following properties are required:

  • url
Type: object

The following properties are required:

  • urls

URL

Type: string

The URL containing tabular data.

Must be at least 1 characters long

URLs

Type: array of string

URLs containing tabular data (for use when data is split into multiple tables).

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

Type: string

Must be at least 1 characters long

Sheet Name

Type: string

Name of the sheet in a workbook

Must be at least 1 characters long

Status Column

Type: string

Used to denote which is the Status column. Defaults to Status.

If any of development, staging, production, test appears in the status column, the row will be ignored unless it is executed in the same environment (as denoted by settings.ENVIRONMENT).

If ignore appears in the status column, the row is ignored.

Must be at least 1 characters long

Headers

Type: array of string

An array of string to denote the headers for the TabularInterface. Useful if the source data does not define headers.

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

Type: string

Must be at least 1 characters long

Skip Header Row

Type: boolean

Whether to skip the header row.

This is a misnomer. It refers to whether the source data contains a header row.

When set to true, every row of the source data is read.

When set to false (default behavior), the first row of the data is treated as the headers value and data starts from the 2nd row onwards.

Each additional property must conform to the following schema

Type: object

Additional properties will be passed on to the __init__ for the TabularInterface reader.

CSV

Type: object

Settings for using scalpel.externals.TabularCSV.

Type: object

The following properties are required:

  • url
Type: object

The following properties are required:

  • urls

URL

Type: string

The URL containing tabular data.

Must be at least 1 characters long

URLs

Type: array of string

URLs containing tabular data (for use when data is split into multiple tables).

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

Type: string

Must be at least 1 characters long

Sheet Name

Type: string

Name of the sheet in a workbook

Must be at least 1 characters long

Status Column

Type: string

Used to denote which is the Status column. Defaults to Status.

If any of development, staging, production, test appears in the status column, the row will be ignored unless it is executed in the same environment (as denoted by settings.ENVIRONMENT).

If ignore appears in the status column, the row is ignored.

Must be at least 1 characters long

Headers

Type: array of string

An array of string to denote the headers for the TabularInterface. Useful if the source data does not define headers.

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

Type: string

Must be at least 1 characters long

Skip Header Row

Type: boolean

Whether to skip the header row.

This is a misnomer. It refers to whether the source data contains a header row.

When set to true, every row of the source data is read.

When set to false (default behavior), the first row of the data is treated as the headers value and data starts from the 2nd row onwards.

Each additional property must conform to the following schema

Type: object

Additional properties will be passed on to the __init__ for the TabularInterface reader.

Google Sheets

Type: object

Settings for using scalpel.externals.GoogleSheets.

Type: object

The following properties are required:

  • url
Type: object

The following properties are required:

  • urls

URL

Type: string

The URL containing tabular data.

Must be at least 1 characters long

URLs

Type: array of string

URLs containing tabular data (for use when data is split into multiple tables).

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

Type: string

Must be at least 1 characters long

Sheet Name

Type: string

Name of the sheet in a workbook

Must be at least 1 characters long

Status Column

Type: string

Used to denote which is the Status column. Defaults to Status.

If any of development, staging, production, test appears in the status column, the row will be ignored unless it is executed in the same environment (as denoted by settings.ENVIRONMENT).

If ignore appears in the status column, the row is ignored.

Must be at least 1 characters long

Headers

Type: array of string

An array of string to denote the headers for the TabularInterface. Useful if the source data does not define headers.

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

Type: string

Must be at least 1 characters long

Skip Header Row

Type: boolean

Whether to skip the header row.

This is a misnomer. It refers to whether the source data contains a header row.

When set to true, every row of the source data is read.

When set to false (default behavior), the first row of the data is treated as the headers value and data starts from the 2nd row onwards.

Each additional property must conform to the following schema

Type: object

Additional properties will be passed on to the __init__ for the TabularInterface reader.

Google Sheets

Type: object

Settings for using scalpel.externals.GoogleSheets.

Type: object

The following properties are required:

  • url
Type: object

The following properties are required:

  • urls

URL

Type: string

The URL containing tabular data.

Must be at least 1 characters long

URLs

Type: array of string

URLs containing tabular data (for use when data is split into multiple tables).

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

Type: string

Must be at least 1 characters long

Sheet Name

Type: string

Name of the sheet in a workbook

Must be at least 1 characters long

Status Column

Type: string

Used to denote which is the Status column. Defaults to Status.

If any of development, staging, production, test appears in the status column, the row will be ignored unless it is executed in the same environment (as denoted by settings.ENVIRONMENT).

If ignore appears in the status column, the row is ignored.

Must be at least 1 characters long

Headers

Type: array of string

An array of string to denote the headers for the TabularInterface. Useful if the source data does not define headers.

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

Type: string

Must be at least 1 characters long

Skip Header Row

Type: boolean

Whether to skip the header row.

This is a misnomer. It refers to whether the source data contains a header row.

When set to true, every row of the source data is read.

When set to false (default behavior), the first row of the data is treated as the headers value and data starts from the 2nd row onwards.

Each additional property must conform to the following schema

Type: object

Additional properties will be passed on to the __init__ for the TabularInterface reader.

Excel

Type: object

Settings for using scalpel.externals.ExcelXLSX.

Type: object

The following properties are required:

  • url
Type: object

The following properties are required:

  • urls

URL

Type: string

The URL containing tabular data.

Must be at least 1 characters long

URLs

Type: array of string

URLs containing tabular data (for use when data is split into multiple tables).

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

Type: string

Must be at least 1 characters long

Sheet Name

Type: string

Name of the sheet in a workbook

Must be at least 1 characters long

Status Column

Type: string

Used to denote which is the Status column. Defaults to Status.

If any of development, staging, production, test appears in the status column, the row will be ignored unless it is executed in the same environment (as denoted by settings.ENVIRONMENT).

If ignore appears in the status column, the row is ignored.

Must be at least 1 characters long

Headers

Type: array of string

An array of string to denote the headers for the TabularInterface. Useful if the source data does not define headers.

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

Type: string

Must be at least 1 characters long

Skip Header Row

Type: boolean

Whether to skip the header row.

This is a misnomer. It refers to whether the source data contains a header row.

When set to true, every row of the source data is read.

When set to false (default behavior), the first row of the data is treated as the headers value and data starts from the 2nd row onwards.

Each additional property must conform to the following schema

Type: object

Additional properties will be passed on to the __init__ for the TabularInterface reader.