Module tidb_query_datatype::codec::mysql::json

The binary JSON format from MySQL 5.7 is as follows:

  JSON doc ::= type value
  type ::=
      0x01 |       // large JSON object
      0x03 |       // large JSON array
      0x04 |       // literal (true/false/null)
      0x05 |       // int16
      0x06 |       // uint16
      0x07 |       // int32
      0x08 |       // uint32
      0x09 |       // int64
      0x0a |       // uint64
      0x0b |       // double
      0x0c |       // utf8mb4 string
  value ::=
      object  |
      array   |
      literal |
      number  |
      string  |
  object ::= element-count size key-entry* value-entry* key* value*
  array ::= element-count size value-entry* value*

  // the number of members in object or number of elements in array
  element-count ::= uint32

  //number of bytes in the binary representation of the object or array
  size ::= uint32
  key-entry ::= key-offset key-length
  key-offset ::= uint32
  key-length ::= uint16    // key length must be less than 64KB
  value-entry ::= type offset-or-inlined-value

  // This field holds either the offset to where the value is stored,
  // or the value itself if it is small enough to be inlined (that is,
  // if it is a JSON literal or a small enough [u]int).
  offset-or-inlined-value ::= uint32
  key ::= utf8mb4-data
  literal ::=
      0x00 |   // JSON null literal
      0x01 |   // JSON true literal
      0x02 |   // JSON false literal
  number ::=  ....    // little-endian format for [u]int(16|32|64), whereas
                      // double is stored in a platform-independent, eight-byte
                      // format using float8store()
  string ::= data-length utf8mb4-data
  data-length ::= uint8*    // If the high bit of a byte is 1, the length
                            // field is continued in the next byte,
                            // otherwise it is the last byte of the length
                            // field. So we need 1 byte to represent
                            // lengths up to 127, 2 bytes to represent
                            // lengths up to 16383, and so on...

Modules

binary
comparison
constants
jcodec
json_depth
json_extract
json_keys
json_length
json_merge
json_modify
json_remove
json_type
json_unquote
modifier
path_expr
serde

Structs

Json	Json implements type json used in tikv by Binary Json. The Binary Json format from MySQL 5.7 is in the following link: (https://github.com/mysql/mysql-server/blob/5.7/sql/json_binary.h#L52) The only difference is that we use large object or large array for the small corresponding ones. That means in our implementation there is no difference between small object and big object, so does array.
JsonRef	Represents a reference of JSON value aiming to reduce memory copy.
PathExpression

Enums

JsonType	The types of Json which follows https://tools.ietf.org/html/rfc7159#section-3
ModifyType	ModifyType is for modify a JSON.

Constants

ERR_CONVERT_FAILED
_IMPL_NUM_FromPrimitive_FOR_JsonType

Traits

JsonDatumPayloadChunkEncoder
JsonDecoder
JsonEncoder

Functions

json_array	Create JSON array by given elements https://dev.mysql.com/doc/refman/5.7/en/json-creation-functions.html#function_json-array
json_object	Create JSON object by given key-value pairs https://dev.mysql.com/doc/refman/5.7/en/json-creation-functions.html#function_json-object
parse_json_path_expr	Parses a JSON path expression. Returns a PathExpression object which can be used in JSON_EXTRACT, JSON_SET and so on.