Interface: ResourcefulColumnDefinition<ColumnBaseSchema>
Extends
LocalResourcefulPropertyDefinition<ColumnBaseSchema>
Type Parameters
| Type Parameter |
|---|
ColumnBaseSchema extends AnySchema |
Properties
| Property | Type | Description | Inherited from |
|---|---|---|---|
aggregatable | boolean | Whether this column can be used in aggregation operations. Defaults to false. | - |
consume? | CustomConsumeFunction | - | LocalResourcefulPropertyDefinition.consume |
default? | any | - | LocalResourcefulPropertyDefinition.default |
deprecated? | boolean | - | LocalResourcefulPropertyDefinition.deprecated |
description? | string | - | LocalResourcefulPropertyDefinition.description |
example? | string | - | LocalResourcefulPropertyDefinition.example |
externalDocs? | ExternalDocumentationObject | - | LocalResourcefulPropertyDefinition.externalDocs |
filterable | boolean | Whether this column can be used in filter operations. Defaults to true. | - |
immutable | boolean | Whether this column is immutable. Defaults to false. | - |
nullable | boolean | - | LocalResourcefulPropertyDefinition.nullable |
prepare? | CustomPrepareFunction | - | LocalResourcefulPropertyDefinition.prepare |
propertyKey | string | - | LocalResourcefulPropertyDefinition.propertyKey |
readAccessControlFilters | ResourcefulAccessControlFilter<LucidModel, LucidRow>[] | - | LocalResourcefulPropertyDefinition.readAccessControlFilters |
relationshipKey? | string | The property name of the relationship which this column acts as a key for | - |
sortable | boolean | Whether this column can be used in sort operations. Defaults to true. | - |
type | ResourcefulDataType | - | LocalResourcefulPropertyDefinition.type |
validationScopes? | ValidationScoper<ColumnBaseSchema>[] | - | LocalResourcefulPropertyDefinition.validationScopes |
writeAccessControlFilters | ResourcefulAccessControlFilter<LucidModel, LucidRow>[] | - | LocalResourcefulPropertyDefinition.writeAccessControlFilters |