All Products
Search
Document Center

Schema

Last Updated: Jan 15, 2021

Description

The table schema of an instance.

Parameters

Parameter

Type

Description

Id

Integer

The ID of the schema.

Description

String

The description of the schema.

Meta

List

The table schema.

TableName

String

The name of the table.

Fields

List

The list of fields.

Name

String

The name of the field.

Type

String

The data type of the field.

Description

String

The description of the field.

Required

Boolean

Specifies whether the field is required.

Example

String

The example value of the field.

GmtCreate

String

The creation time.

GmtModified

String

The modification time.

Examples

{
    "Id": 123,
    "Description": "foo",
    "Meta": [
        {
            "TableName": "user",
            "Fields": [
                {
                    "Name": "user_id",
                    "Type": "BIGINT",
                    "Description": "Unique user ID",
                    "Required": true,
                    "Example": "1234567"
                },
                {
                    "Name": "user_id_type",
                    "Type": "STRING",
                    "Description": "User registration type",
                    "Required": false,
                    "Example": "1: app-based registration, 2: phone number-based registration, 3: WeChat account-based registration"
                }
            ]
        },
        {
            "TableName": "item",
            "Fields": [
                {
                    "Name": "user_id",
                    "Type": "BIGINT",
                    "Description": "Unique user ID",
                    "Required": true,
                    "Example": "1234567"
                },
                {
                    "Name": "user_id_type",
                    "Type": "STRING",
                    "Description": "User registration type",
                    "Required": false,
                    "Example": "1: app-based registration, 2: phone number-based registration, 3: WeChat account-based registration"
                }
            ]
        },
        {
            "TableName": "behavior",
            "Fields": [
                {
                    "Name": "user_id",
                    "Type": "BIGINT",
                    "Description": "Unique user ID",
                    "Required": true,
                    "Example": "1234567"
                },
                {
                    "Name": "user_id_type",
                    "Type": "STRING",
                    "Description": "User registration type",
                    "Required": false,
                    "Example": "1: app-based registration, 2: phone number-based registration, 3: WeChat account-based registration"
                }
            ]
        }
    ],
    "GmtCreate": "2009-02-13T23:31:30.000Z",
    "GmtModified": "2009-02-13T23:31:30.000Z"
}