Edit page in Livemark
(2023-06-06 13:09)

String Field

Overview

The field contains strings, that is, sequences of characters. Read more in Table Schema Standard. Currently supported formats:

Example

from frictionless import Schema, extract, fields

data = [['name'], ['value']]
rows = extract(data, schema=Schema(fields=[fields.StringField(name='name')]))
print(rows)

{'memory': [{'name': 'value'}]}

Reference

fields.StringField (class)

fields.StringField (class)

Field representation

Signature

(*, name: str, title: Optional[str] = None, description: Optional[str] = None, format: str = default, missing_values: List[str] = NOTHING, constraints: dict = NOTHING, rdf_type: Optional[str] = None, example: Optional[str] = None, schema: Optional[Schema] = None) -> None

Parameters

  • name (str)
  • title (Optional[str])
  • description (Optional[str])
  • format (str)
  • missing_values (List[str])
  • constraints (dict)
  • rdf_type (Optional[str])
  • example (Optional[str])
  • schema (Optional[Schema])

fields.stringField.name (property)

Signature

str

fields.stringField.type (property)

Signature

ClassVar[str]

fields.stringField.title (property)

Signature

Optional[str]

fields.stringField.description (property)

Signature

Optional[str]

fields.stringField.format (property)

Signature

str

fields.stringField.missing_values (property)

Signature

List[str]

fields.stringField.constraints (property)

Signature

dict

fields.stringField.rdf_type (property)

Signature

Optional[str]

fields.stringField.example (property)

Signature

Optional[str]

fields.stringField.schema (property)

Signature

Optional[Schema]

fields.stringField.builtin (property)

Signature

ClassVar[bool]

fields.stringField.supported_constraints (property)

Signature

ClassVar[List[str]]