Back to top

    ReQL command: binary

    Command syntax

    r.binary(data) → binary


    Encapsulate binary data within a query.

    The type of data binary accepts depends on the client language. In Ruby, it expects a String object.

    Binary objects returned to the client in JavaScript will also be of the String type. This can be changed with the binary_format option provided to run to return “raw” objects.

    Only a limited subset of ReQL commands may be chained after binary:

    • coerce_to can coerce binary objects to string types
    • count will return the number of bytes in the object
    • slice will treat bytes like array indexes (i.e., slice(10,20) will return bytes 10–19)
    • type_of returns PTYPE<BINARY>
    • info will return information on a binary object.

    Example: Save an avatar image to a existing user record.

    f ='./default_avatar.png', 'rb')
    avatar_image =
    r.table('users').get(100).update({:avatar => r.binary(avatar_image)}).run(conn)

    Example: Get the size of an existing avatar image.


    Read more details about RethinkDB’s binary object support: Storing binary objects.

    Get more help

    Couldn't find what you were looking for?