Formats Reference
It's a formats reference supported by the main Frictionless package. If you have installed external plugins, there can be more formats available. Below we're listing a format group name (or a parser name) like Excel, which is used, for example, for xlsx
, xls
etc formats. Options can be used for creating dialects, for example, dialect = ExcelDialect(sheet=1)
.
#
Bigquery#
ProjectType: str
Project
#
DatasetType: str
Dataset
#
TableType: str
Table
#
Ckan#
ResourceType: str
Resource
#
DatasetType: str
Dataset
#
ApikeyType: str
Apikey
#
FieldsType: array
Limit ckan query to certain fields
#
LimitType: int
Limit number of returned entries
#
SortType: str
Sort returned entries, e.g. by date descending: date desc
#
FiltersType: dict
Filter data, e.g. field with value: { "key": "value" }
#
Csv#
DelimiterType: str
Csv delimiter
#
Line TerminatorType: str
Csv line terminator
#
Quote CharType: str
Csv quote char
#
Double QuoteType: bool
Csv double quote
#
Escape CharType: str
Csv escape char
#
Null SequenceType: str
Csv null sequence
#
Skip Initial SpaceType: bool
Csv skip initial space
#
Comment CharType: str
Csv comment char
#
Excel#
SheetType: int|str
Number from 1 or name of an excel sheet
#
Workbook CacheType: dict
Workbook cache
#
Fill Merged CellsType: bool
Whether to fill merged cells
#
Preserve FormattingType: bool
Whither to preserve formatting
#
Adjust Floating Point ErrorType: bool
Whether to adjust floating point error
#
GsheetsThere are no options available.
#
Html#
SelectorType: str
Html selector
#
Inline#
KeysType: str[]
A list of strings to use as data keys
#
KeyedType: bool
Whether data rows are keyed
#
Inline#
KeysType: str[]
A list of strings to use as data keys
#
KeyedType: bool
Whether data rows are keyed
#
Json#
KeysType: str[]
A list of strings to use as data keys
#
KeyedType: bool
Whether data rows are keyed
#
PropertyType: str
A path within json to the data
#
Ods#
SheetType: str
Sheet
#
PandasThere are no options available.
#
SpssThere are no options available.
#
Sql#
TableType: str
Table name
#
PrefixType: str
Prefix for all table names
#
Order ByType: str
Order_by statement passed to sql
#
WhereType: str
Where statement passed to sql
#
NamespaceType: str
Sql schema
#
BasepathType: str
A basepath, for example, for sqlite path