frame/schema
src/frame/schema.tur
defn
field
(field [name : cstr type : int nullable : int] :)
construct a schema field.
Parameters
| name | :cstr column name (copied internally) | |
| type | :int type tag from frame/type | |
| nullable | :int, 0 = no, 1 = yes |
Returns
:int opaque field handle.
Example
(field "age" (type-int32) 1)
Since: FR0
defn
field-name
(field-name [f : int] :)
field name. Since: FR0
defn
field-type
(field-type [f : int] :)
field type tag. Since: FR0
defn
field-nullable
(field-nullable [f : int] :)
0 or 1. Since: FR0
defn
schema
(schema [fields : int] :)
construct a schema from a cons list of field handles.
Parameters
| fields | cons list of :int field handles (ownership transferred) |
Returns
:int opaque schema handle. Free with schema-free.
Example
(schema (cons (field "x" (type-int32) 0) (cons (field "y" (type-float64) 0) 0)))
Since: FR0
defn
schema-arity
(schema-arity [s : int] :)
number of fields. Since: FR0
defn
schema-field-at
(schema-field-at [s : int i : int] :)
field handle at index i (0-based). Returns 0 if out of range.
Since: FR0
defn
schema-fields
(schema-fields [s : int] :)
a cons list of field handles (newly allocated cells).
Since: FR0
defn
schema-names
(schema-names [s : int] :)
a cons list of :cstr column names (the cstrs point into field storage).
Since: FR0
defn
schema-types
(schema-types [s : int] :)
a cons list of :int type tags. Since: FR0
defn
schema-index-of
(schema-index-of [s : int name : cstr] :)
index of the named field, or -1 if not found. Since: FR0
defn
schema-free
(schema-free [s : int] :)
free a schema, every owned field, and every field name.
Since: FR0