Module Values_1.FieldSource

The Field object has information about the different properties associated with a field in the connector.

Sourcetype nonrec t = {
  1. fieldName : EntityFieldName.t option;
    (*

    A unique identifier for the field.

    *)
  2. label : FieldLabel.t option;
    (*

    A readable label used for the field.

    *)
  3. description : FieldDescription.t option;
    (*

    A description of the field.

    *)
  4. fieldType : FieldDataType.t option;
    (*

    The type of data in the field.

    *)
  5. isPrimaryKey : Values_0.Bool_.t option;
    (*

    Indicates whether this field can used as a primary key for the given entity.

    *)
  6. isNullable : Values_0.Bool_.t option;
    (*

    Indicates whether this field can be nullable or not.

    *)
  7. 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.

    *)
  8. 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.

    *)
  9. isPartitionable : Values_0.Bool_.t option;
    (*

    Indicates whether a given field can be used in partitioning the query made to SaaS.

    *)
  10. isCreateable : Values_0.Bool_.t option;
    (*

    Indicates whether this field can be created as part of a destination write.

    *)
  11. isUpdateable : Values_0.Bool_.t option;
    (*

    Indicates whether this field can be updated as part of a destination write.

    *)
  12. isUpsertable : Values_0.Bool_.t option;
    (*

    Indicates whether this field can be upserted as part of a destination write.

    *)
  13. isDefaultOnCreate : Values_0.Bool_.t option;
    (*

    Indicates whether this field is populated automatically when the object is created, such as a created at timestamp.

    *)
  14. supportedValues : Values_0.ListOfString.t option;
    (*

    A list of supported values for the field.

    *)
  15. supportedFilterOperators : FieldFilterOperatorsList.t option;
    (*

    Indicates the support filter operators for this field.

    *)
  16. parentField : Values_0.String_.t option;
    (*

    A parent field name for a nested field.

    *)
  17. nativeDataType : Values_0.String_.t option;
    (*

    The data type returned by the SaaS API, such as “picklist” or “textarea” from Salesforce.

    *)
  18. customProperties : CustomProperties.t option;
    (*

    Optional map of keys which may be returned.

    *)
}
Sourceval make : ?fieldName:??? -> ?label:??? -> ?description:??? -> ?fieldType:??? -> ?isPrimaryKey:??? -> ?isNullable:??? -> ?isRetrievable:??? -> ?isFilterable:??? -> ?isPartitionable:??? -> ?isCreateable:??? -> ?isUpdateable:??? -> ?isUpsertable:??? -> ?isDefaultOnCreate:??? -> ?supportedValues:??? -> ?supportedFilterOperators:??? -> ?parentField:??? -> ?nativeDataType:??? -> ?customProperties:??? -> unit -> t
Sourceval 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 ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t