Skip to main content

Types

All Convex documents are defined as Javascript objects. These objects can have field values of any of the types below.

You can codify the shape of documents within your tables by defining a schema.

Convex Types

Convex supports the following types:

Convex TypeJavaScript TypeExample UsageNotes
IdIddoc._id, new Id(tableName, id)See data modeling docs.
NullnullnullJavaScript's undefined is not a valid Convex value. Use null instead.
Int64bigint3nInt64s only support BigInts between -2^63 and 2^63-1. Convex supports bigints in most modern browsers.
Float64number3.1Convex supports all IEEE-754 double-precision floating point numbers (such as NaNs).
Booleanbooleantrue
Stringstring"abc"Strings are stored as UTF-8 and must be valid Unicode sequences. Strings must be smaller than the 1MB total size limit when encoded as UTF-8.
BytesArrayBuffernew ArrayBuffer(8)Convex supports first class bytestrings, passed in as ArrayBuffers. Bytestrings must be smaller than the 1MB total size limit for Convex types.
ArrayArray[1, 3.2, "abc"]Arrays can have at most 1024 values.
SetSetnew Set([1, 3.2, "abc"])Sets store only unique values. Sets can have at most 1024 values.
MapMapnew Map([["a", "abc"]])Maps support arbitrary Convex types as keys, where objects can only have strings for field names. Maps can have at most 1024 values.
Objectobject{a: "abc"}Convex only supports "plain old JavaScript objects" (objects that do not have a custom prototype). Convex includes all enumerable properties. Objects can have at most 1024 entries. Field names must be nonempty and not start with "$".

Limits

Convex values must be less than 1MB in total size. This is an approximate limit for now, but if you're running into these limits and would like a more precise method to calculate a document's size, reach out to us. Documents can have nested values, such as objects, maps, sets, and arrays that contain other Convex types. Convex types can have at most 16 levels of nesting, and the cumulative size of a nested tree of values must be under the 1MB limit.

Table names may contain alphanumeric characters ("a" to "z", "A" to "Z", and "0" to "9") and underscores ("_"), and they cannot start with an underscore.

If any of these limits don't work for you, let us know!