@squidcloud/client
    Preparing search index...

    Type Alias TopLevelPropertySchema

    TopLevelPropertySchema: PropertySchema & {
        dataType?: string;
        hidden?: boolean;
        isComputed?: boolean;
        isDefaultComputed?: boolean;
        primaryKey?: boolean;
    }

    Extended JSON schema for a top-level property, including database-related metadata.

    Type declaration

    • OptionaldataType?: string

      The database data type that is represented by this property. This is often different from the actual property type, with is a Javascript primitive. For example, for a SMALLINT the dataType would be 'smallint', but the type would be 'integer'.

    • Optionalhidden?: boolean

      This indicates that although the field exists on the db, it should be ignored by squid.

    • OptionalisComputed?: boolean

      Whether the property is computed based on other properties or some formula. If true, readonly also needs to be true and this field should not be part of an insert statement.

    • OptionalisDefaultComputed?: boolean

      Whether the default value generated by the database. CURRENT_DATE is something generated by the database vs 'Hello' which is a constant.

    • OptionalprimaryKey?: boolean

      Marks the property as a primary key.

    Settings

    Member Visibility