Liking cljdoc? Tell your friends :D

metabase.sync.sync-metadata.fields.common

Schemas and functions shared by different metabase.sync.sync-metadata.fields.* namespaces.

Schemas and functions shared by different `metabase.sync.sync-metadata.fields.*` namespaces.
raw docstring

canonical-nameclj

(canonical-name field)

Return the lower-cased 'canonical' name that should be used to uniquely identify field -- this is done to ignore case differences when syncing, e.g. we will consider FIELD and field to mean the same thing.

Return the lower-cased 'canonical' name that should be used to uniquely identify `field` -- this is done to ignore
case differences when syncing, e.g. we will consider `FIELD` and `field` to mean the same thing.
sourceraw docstring

field-metadata-name-for-loggingclj

(field-metadata-name-for-logging table field-metadata)

Inputs: [table :- i/TableInstance field-metadata :- TableMetadataFieldWithOptionalID] Returns: s/Str

Return a 'name for logging' for a map that conforms to the TableMetadataField schema.

(field-metadata-name-for-logging table field-metadata) ; -> "Table 'venues' Field 'name'"
Inputs: [table :- i/TableInstance field-metadata :- TableMetadataFieldWithOptionalID]
Returns: s/Str

Return a 'name for logging' for a map that conforms to the `TableMetadataField` schema.

    (field-metadata-name-for-logging table field-metadata) ; -> "Table 'venues' Field 'name'"
sourceraw docstring

matching-field-metadataclj

(matching-field-metadata field-metadata other-metadata)

Inputs: [field-metadata :- TableMetadataFieldWithOptionalID other-metadata :- #{TableMetadataFieldWithOptionalID}] Returns: (s/maybe TableMetadataFieldWithOptionalID)

Find Metadata that matches field-metadata from a set of other-metadata, if any exists. Useful for finding the corresponding Metabase Field for field metadata from the DB, or vice versa.

Inputs: [field-metadata :- TableMetadataFieldWithOptionalID other-metadata :- #{TableMetadataFieldWithOptionalID}]
Returns: (s/maybe TableMetadataFieldWithOptionalID)

Find Metadata that matches `field-metadata` from a set of `other-metadata`, if any exists. Useful for finding the
corresponding Metabase Field for field metadata from the DB, or vice versa.
sourceraw docstring

ParentIDclj

Schema for the parent-id of a Field, i.e. an optional ID.

Schema for the `parent-id` of a Field, i.e. an optional ID.
sourceraw docstring

special-typeclj

(special-type field-metadata)

Inputs: [field-metadata :- (s/maybe i/TableMetadataField)] Returns: (s/maybe su/FieldType)

Determine a the appropriate special-type for a Field with field-metadata.

Inputs: [field-metadata :- (s/maybe i/TableMetadataField)]
Returns: (s/maybe su/FieldType)

Determine a the appropriate `special-type` for a Field with `field-metadata`.
sourceraw docstring

TableMetadataFieldWithIDclj

Schema for TableMetadataField with an included ID of the corresponding Metabase Field object. our-metadata is always returned in this format. (The ID is needed in certain places so we know which Fields to retire, and the parent ID of any nested-fields.)

Schema for `TableMetadataField` with an included ID of the corresponding Metabase Field object.
`our-metadata` is always returned in this format. (The ID is needed in certain places so we know which Fields to
retire, and the parent ID of any nested-fields.)
sourceraw docstring

TableMetadataFieldWithOptionalIDclj

Schema for either i/TableMetadataField (db-metadata) or TableMetadataFieldWithID (our-metadata).

Schema for either `i/TableMetadataField` (`db-metadata`) or `TableMetadataFieldWithID` (`our-metadata`).
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close