Class TableSchema

A table description is a JSON object that describes a table within a CSV file.

Implements

CsvwTableDescription

Index

Constructors

constructor

new TableSchema(url: string, ...columns: string[]): TableSchema
Parameters
- url: string
- ...columns: string[]
Returns TableSchema
- Defined in packages/core/src/lib/rdf2csvw/schema/table-schema.ts:30

Properties

locked

locked: boolean = false

tableSchema

tableSchema: {
    columns: ColumnSchema[];
    foreignKeys: CsvwForeignKeyDefinition[];
    primaryKey: string[];
}

An object property that provides a single schema description as described in section 5.5 Schemas, used as the default for all the tables in the group. This may be provided as an embedded object within the JSON metadata or as a URL reference to a separate JSON object that is a schema description.

url

url: string

This link property gives the single URL of the CSV file that the table is held in, relative to the location of the metadata document.

Methods

addColumn

addColumn(
    name: string,
    options?: Partial<
        Pick<
            ColumnSchema,
            | "aboutUrl"
            | "datatype"
            | "propertyUrl"
            | "required"
            | "valueUrl"
            | "titles",
        >,
    >,
): ColumnSchema
Parameters
- name: string
- Optionaloptions: Partial<
      Pick<
          ColumnSchema,
          | "aboutUrl"
          | "datatype"
          | "propertyUrl"
          | "required"
          | "valueUrl"
          | "titles",
      >,
  >
Returns ColumnSchema
- Defined in packages/core/src/lib/rdf2csvw/schema/table-schema.ts:47

addPrimaryKey

addPrimaryKey(columnName: string): void
Parameters
- columnName: string
Returns void
- Defined in packages/core/src/lib/rdf2csvw/schema/table-schema.ts:144

clone

clone(): TableSchema
Returns TableSchema
- Defined in packages/core/src/lib/rdf2csvw/schema/table-schema.ts:162

getColumn

getColumn(name: string): undefined | ColumnSchema
Parameters
- name: string
Returns undefined | ColumnSchema
- Defined in packages/core/src/lib/rdf2csvw/schema/table-schema.ts:43

mergeColumn

mergeColumn(
    name: string,
    options?: Partial<
        Pick<
            ColumnSchema,
            | "aboutUrl"
            | "datatype"
            | "propertyUrl"
            | "required"
            | "valueUrl"
            | "titles",
        >,
    >,
): ColumnSchema
Parameters
- name: string
- Optionaloptions: Partial<
      Pick<
          ColumnSchema,
          | "aboutUrl"
          | "datatype"
          | "propertyUrl"
          | "required"
          | "valueUrl"
          | "titles",
      >,
  >
Returns ColumnSchema
- Defined in packages/core/src/lib/rdf2csvw/schema/table-schema.ts:60

`Private`mergeDatatype

mergeDatatype(
aDatatype: CsvwBuiltinDatatype | CsvwDatatype,
bDatatype: CsvwBuiltinDatatype | CsvwDatatype,
): CsvwBuiltinDatatype | CsvwDatatype
Merges two datatypes into a single datatype.
Parameters
- aDatatype: CsvwBuiltinDatatype | CsvwDatatype
  The first datatype.
- bDatatype: CsvwBuiltinDatatype | CsvwDatatype
  The second datatype.
Returns CsvwBuiltinDatatype | CsvwDatatype
The merged datatype.
- Defined in packages/core/src/lib/rdf2csvw/schema/table-schema.ts:82

removeColumn

removeColumn(name: string): void
Parameters
- name: string
Returns void
- Defined in packages/core/src/lib/rdf2csvw/schema/table-schema.ts:117

removePrimaryKey

removePrimaryKey(columnName: string): void
Parameters
- columnName: string
Returns void
- Defined in packages/core/src/lib/rdf2csvw/schema/table-schema.ts:153

renameColumn

renameColumn(name: string, newTitle: string): void
Parameters
- name: string
- newTitle: string
Returns void
- Defined in packages/core/src/lib/rdf2csvw/schema/table-schema.ts:133

Class TableSchema

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns TableSchema

Properties

locked

tableSchema

url

Methods

addColumn

Parameters

Returns ColumnSchema

addPrimaryKey

Parameters

Returns void

clone

Returns TableSchema

getColumn

Parameters

Returns undefined | ColumnSchema

mergeColumn

Parameters

Returns ColumnSchema

PrivatemergeDatatype

Parameters

Returns CsvwBuiltinDatatype | CsvwDatatype

removeColumn

Parameters

Returns void

removePrimaryKey

Parameters

Returns void

renameColumn

Parameters

Returns void

Settings

On This Page

`Private`mergeDatatype