Skip to content

spec_JA.md

Latest commit

 

History

History
378 lines (321 loc) · 15.4 KB

spec_JA.md

File metadata and controls

378 lines (321 loc) · 15.4 KB
Raw

Smart Data Models

エンティティTableSchemaFrictionlessData

オープン・ライセンス

文書は自動的に生成される

グローバル記述：テーブルスキーマ仕様に準拠した、このリソースのテーブルスキーマ。元のフリクションレス・データからスマート・データ・モデル・イニシアチブのために変換された。

バージョン: 0.0.2

プロパティのリスト

[*] 属性に型がない場合は、複数の型があるか、異なるフォーマット/パターンがある可能性があるためです。

  • alternateName[string]: この項目の別名
  • dataProvider[string]: ハーモナイズされたデータ・エンティティの提供者を識別する一連の文字。
  • dateCreated[date-time]: エンティティの作成タイムスタンプ。これは通常、ストレージプラットフォームによって割り当てられます。
  • dateModified[date-time]: エンティティの最終変更のタイムスタンプ。これは通常、ストレージプラットフォームによって割り当てられる。
  • description[string]: この商品の説明
  • fields[array]: テーブル・スキーマ・フィールド・オブジェクトの配列
  • foreignKeys[array]:
  • id[*]: エンティティの一意識別子
  • missingValues[array]: 多くのデータセットでは、値が収集されなかったり、存在しなかったりしたために、データの値が欠落している。missingValues'プロパティは、これらの値がnullと同等に解釈されることを示す方法を提供する。missingValues'は、特定のフィールドのデータ型ではなく文字列です。これにより、キャスト前の比較や、'number'フィールドに'-'で示される欠損値を持たせるなど、フィールドのデータ型とは異なる欠損値を持たせることができます。文字列型フィールドの場合、'missingValue' の既定値はありません (文字列フィールドの場合、空文字列 '' は有効な値であり、NULL を示す必要はありません)。ソースで検出された場合、'null'、'not present'、または 'blank' 値と見なされます。
  • name[string]: このアイテムの名前
  • owner[array]: 所有者の固有IDを参照するJSONエンコードされた文字列を含むリスト。
  • primaryKey[array]: primaryKeyのフィールド名は一意でなければならず(MUST)、関連するテーブルのフィールド名と一致しなければならない(MUST)。一つのフィールドの値が主キーであることを示す、一つの値を持つ配列があっても構わない。主キーはフィールド名またはフィールド名の配列で、その値はテーブルの各行を 'MUST' 一意に識別します。
  • seeAlso[*]: アイテムに関する追加リソースを指すURIのリスト
  • source[string]: エンティティ・データの元のソースを URL として示す一連の文字。ソース・プロバイダの完全修飾ドメイン名、またはソース・オブジェクトの URL を推奨する。
  • type[string]: これは TableSchemaFrictionlessData でなければならない。NGSIエンティティタイプ

必須プロパティ

  • fields
  • id
  • type

このデータモデルは、https://frictionlessdata.io/ にあるオリジナルのフリクションレス・データから来ている。いくつかの変更点がある。1)idとtypeは、NGSI標準に必須である限り、必須とされました。 2)jsonスキーマの構造は、スマート・データ・モデルの公式フォーマットに合わせられました。貢献マニュアルhttps://bit.ly/contribution_manualを参照。

プロパティのデータモデル記述

アルファベット順（クリックで詳細表示）

full yaml details 
TableSchemaFrictionlessData:      
  description: 'A Table Schema for this resource, compliant with the Table Schema specification. Converted for Smart Data Models initiative from original frictionless data'      
  properties:      
    alternateName:      
      description: An alternative name for this item      
      type: string      
      x-ngsi:      
        type: Property      
    dataProvider:      
      description: A sequence of characters identifying the provider of the harmonised data entity      
      type: string      
      x-ngsi:      
        type: Property      
    dateCreated:      
      description: Entity creation timestamp. This will usually be allocated by the storage platform      
      format: date-time      
      type: string      
      x-ngsi:      
        type: Property      
    dateModified:      
      description: Timestamp of the last modification of the entity. This will usually be allocated by the storage platform      
      format: date-time      
      type: string      
      x-ngsi:      
        type: Property      
    description:      
      description: A description of this item      
      type: string      
      x-ngsi:      
        type: Property      
    fields:      
      description: An array of Table Schema Field objects      
      items:      
        type: object      
      type: array      
      x-ngsi:      
        type: Property      
    foreignKeys:      
      description: ""      
      items:      
        type: string      
      type: array      
      x-ngsi:      
        type: Property      
    id:      
      anyOf:      
        - description: Identifier format of any NGSI entity      
          maxLength: 256      
          minLength: 1      
          pattern: ^[\w\-\.\{\}\$\+\*\[\]`|~^@!,:\\]+$      
          type: string      
          x-ngsi:      
            type: Property      
        - description: Identifier format of any NGSI entity      
          format: uri      
          type: string      
          x-ngsi:      
            type: Property      
      description: Unique identifier of the entity      
      x-ngsi:      
        type: Property      
    missingValues:      
      description: 'Many datasets arrive with missing data values, either because a value was not collected or it never existed. Missing values may be indicated simply by the value being empty in other cases a special value may have been used e.g. ''-'', ''NaN'', ''0'', ''-9999'' etc.The ''missingValues'' property provides a way to indicate that these values should be interpreted as equivalent to null. The ''missingValues'' are strings rather than being the data type of the particular field. This allows for comparison prior to casting and for fields to have missing value which are not of their type, for example a ''number'' field to have missing values indicated by ''-''.The default value of ''missingValue'' for a non-string type field is the empty string ''''. For string type fields there is no default for ''missingValue'' (for string fields the empty string '''' is a valid value and need not indicate null). Values that when encountered in the source, should be considered as ''null'', ''not present'', or ''blank'' values'      
      items:      
        type: string      
      type: array      
      x-ngsi:      
        type: Property      
    name:      
      description: The name of this item      
      type: string      
      x-ngsi:      
        type: Property      
    owner:      
      description: A List containing a JSON encoded sequence of characters referencing the unique Ids of the owner(s)      
      items:      
        anyOf:      
          - description: Identifier format of any NGSI entity      
            maxLength: 256      
            minLength: 1      
            pattern: ^[\w\-\.\{\}\$\+\*\[\]`|~^@!,:\\]+$      
            type: string      
            x-ngsi:      
              type: Property      
          - description: Identifier format of any NGSI entity      
            format: uri      
            type: string      
            x-ngsi:      
              type: Property      
        description: Unique identifier of the entity      
        x-ngsi:      
          type: Property      
      type: array      
      x-ngsi:      
        type: Property      
    primaryKey:      
      description: 'Field name in the primaryKey ''MUST'' be unique, and ''MUST'' match a field name in the associated table. It is acceptable to have an array with a single value, indicating that the value of a single field is the primary key. A primary key is a field name or an array of field names, whose values ''MUST'' uniquely identify each row in the table'      
      items:      
        type: string      
      minItems: 1      
      type: array      
      x-ngsi:      
        type: Property      
    seeAlso:      
      description: list of uri pointing to additional resources about the item      
      oneOf:      
        - items:      
            format: uri      
            type: string      
          minItems: 1      
          type: array      
        - format: uri      
          type: string      
      x-ngsi:      
        type: Property      
    source:      
      description: 'A sequence of characters giving the original source of the entity data as a URL. Recommended to be the fully qualified domain name of the source provider, or the URL to the source object'      
      type: string      
      x-ngsi:      
        type: Property      
    type:      
      description: it has to be TableSchemaFrictionlessData. NGSI entity type      
      type: string      
      x-ngsi:      
        type: Property      
  required:      
    - fields      
    - id      
    - type      
  type: object      
  x-derived-from: ""      
  x-disclaimer: 'Redistribution and use in source and binary forms, with or without modification, are permitted  provided that the license conditions are met. Copyleft (c) 2022 Contributors to Smart Data Models Program'      
  x-license-url: https://github.com/smart-data-models/dataModel.FrictionlessData/blob/master/TableSchemaFrictionlessData/LICENSE.md      
  x-model-schema: ""      
  x-model-tags: SDG      
  x-version: 0.0.2

ペイロードの例

TableSchemaFrictionlessData NGSI-v2 キー値の例

これはJSON-LD形式のTableSchemaFrictionlessDataをkey-valuesとした例である。これはNGSI-v2と互換性があり、options=keyValuesを使用すると個々のエンティティのコンテキストデータを返す。

show/hide example 
{  
  "id": "urn:ngsi-ld:TableSchemaFrictionlessData:XVFE:0034",  
  "type": "TableSchemaFrictionlessData",  
  "fields": [  
    {  
      "name": "first_name",  
      "type": "string",  
      "constraints": {  
        "required": true  
      }  
    },  
    {  
      "name": "age",  
      "type": "integer"  
    }  
  ],  
  "primaryKey": [  
    "name"  
  ]  
}

TableSchemaFrictionlessData NGSI-v2 正規化例

以下は、正規化されたJSON-LD形式のTableSchemaFrictionlessDataの例である。これは、オプションを使用しない場合は NGSI-v2 と互換性があり、個々のエンティティのコンテキスト・データを返します。

show/hide example 
{  
  "id": "urn:ngsi-ld:TableSchemaFrictionlessData:XVFE:0034",  
  "type": "TableSchemaFrictionlessData",  
  "fields": {  
    "type": "StructuredValue",  
    "value": [  
      {  
        "name": "first_name",  
        "type": "string",  
        "constraints": {  
          "required": true  
        }  
      },  
      {  
        "name": "age",  
        "type": "integer"  
      }  
    ]  
  },  
  "primaryKey": {  
    "type": "StructuredValue",  
    "value": [  
      "name"  
    ]  
  }  
}

TableSchemaFrictionlessData NGSI-LD キー値の例

以下はTableSchemaFrictionlessDataをJSON-LD形式でkey-valuesとした例である。options=keyValues`を使うとNGSI-LDと互換性があり、個々のエンティティのコンテキストデータを返す。

show/hide example 
{  
  "id": "urn:ngsi-ld:TableSchemaFrictionlessData:XVFE:0034",  
  "type": "TableSchemaFrictionlessData",  
  "fields": [  
    {  
      "name": "first_name",  
      "type": "string",  
      "constraints": {  
        "required": true  
      }  
    },  
    {  
      "name": "age",  
      "type": "integer"  
    }  
  ],  
  "primaryKey": [  
    "name"  
  ],  
  "@context": [  
    "https://raw.githubusercontent.com/smart-data-models/dataModel.FrictionlessData/master/context.jsonld"  
  ]  
}

TableSchemaFrictionlessData NGSI-LD 正規化例

以下は、正規化された JSON-LD 形式の TableSchemaFrictionlessData の例である。これは、オプションを使用しない場合の NGSI-LD と互換性があり、個々のエンティティのコンテキスト・データを返します。

show/hide example 
{  
  "id": "urn:ngsi-ld:TableSchemaFrictionlessData:XVFE:0034",  
  "type": "TableSchemaFrictionlessData",  
  "fields": {  
    "type": "Property",  
    "value": [  
      {  
        "name": "first_name",  
        "type": "string",  
        "constraints": {  
          "required": true  
        }  
      },  
      {  
        "name": "age",  
        "type": "integer"  
      }  
    ]  
  },  
  "primaryKey": {  
    "type": "Property",  
    "value": [  
      "name"  
    ]  
  },  
  "@context": [  
        "https://raw.githubusercontent.com/smart-data-models/dataModel.FrictionlessData/master/context.jsonld"  
    ]  
}

マグニチュード単位の扱い方については、FAQ 10を参照のこと。

Smart Data Models +++ Contribution Manual +++ About