Values_1.FieldSourceThe Field object has information about the different properties associated with a field in the connector.
type nonrec t = {fieldName : EntityFieldName.t option;A unique identifier for the field.
*)label : FieldLabel.t option;A readable label used for the field.
*)description : FieldDescription.t option;A description of the field.
*)fieldType : FieldDataType.t option;The type of data in the field.
*)isPrimaryKey : Values_0.Bool_.t option;Indicates whether this field can used as a primary key for the given entity.
*)isNullable : Values_0.Bool_.t option;Indicates whether this field can be nullable or not.
*)isRetrievable : Values_0.Bool_.t option;Indicates whether this field can be added in Select clause of SQL query or whether it is retrievable or not.
*)isFilterable : Values_0.Bool_.t option;Indicates whether this field can used in a filter clause (WHERE clause) of a SQL statement when querying data.
*)isPartitionable : Values_0.Bool_.t option;Indicates whether a given field can be used in partitioning the query made to SaaS.
*)isCreateable : Values_0.Bool_.t option;Indicates whether this field can be created as part of a destination write.
*)isUpdateable : Values_0.Bool_.t option;Indicates whether this field can be updated as part of a destination write.
*)isUpsertable : Values_0.Bool_.t option;Indicates whether this field can be upserted as part of a destination write.
*)isDefaultOnCreate : Values_0.Bool_.t option;Indicates whether this field is populated automatically when the object is created, such as a created at timestamp.
*)supportedValues : Values_0.ListOfString.t option;A list of supported values for the field.
*)supportedFilterOperators : FieldFilterOperatorsList.t option;Indicates the support filter operators for this field.
*)parentField : Values_0.String_.t option;A parent field name for a nested field.
*)nativeDataType : Values_0.String_.t option;The data type returned by the SaaS API, such as “picklist” or “textarea” from Salesforce.
*)customProperties : CustomProperties.t option;Optional map of keys which may be returned.
*)}val make :
?fieldName:EntityFieldName.t ->
?label:FieldLabel.t ->
?description:FieldDescription.t ->
?fieldType:FieldDataType.t ->
?isPrimaryKey:Values_0.Bool_.t ->
?isNullable:Values_0.Bool_.t ->
?isRetrievable:Values_0.Bool_.t ->
?isFilterable:Values_0.Bool_.t ->
?isPartitionable:Values_0.Bool_.t ->
?isCreateable:Values_0.Bool_.t ->
?isUpdateable:Values_0.Bool_.t ->
?isUpsertable:Values_0.Bool_.t ->
?isDefaultOnCreate:Values_0.Bool_.t ->
?supportedValues:Values_0.ListOfString.t ->
?supportedFilterOperators:FieldFilterOperatorsList.t ->
?parentField:Values_0.String_.t ->
?nativeDataType:Values_0.String_.t ->
?customProperties:CustomProperties.t ->
unit ->
tval to_value :
t ->
[> `Structure of
(string
* [> `Boolean of Values_0.Bool_.t
| `Enum of string
| `List of [> `Enum of string | `String of string ] list
| `Map of
([> `String of Values_0.String_.t ]
* [> `String of Values_0.String_.t ])
list
| `String of EntityFieldName.t ])
list ]