Struct tidb_query_datatype::codec::mysql::json::Json

pub struct Json {
    type_code: JsonType,
    pub value: Vec<u8>,
}

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.

Fields

type_code: JsonType

value: Vec<u8>

The binary encoded json data in bytes

Implementations

impl Json

pub fn merge(bjs: Vec<JsonRef<'_>>) -> Result<Json>

merge is the implementation for JSON_MERGE in mysql https://dev.mysql.com/doc/refman/5.7/en/json-modification-functions.html#function_json-merge

The merge rules are listed as following:

1. adjacent arrays are merged to a single array;
2. adjacent object are merged to a single object;
3. a scalar value is autowrapped as an array before merge;
4. an adjacent array and object are merged by autowrapping the object as an array.

See MergeBinary() in TiDB json/binary_function.go

impl Json

pub fn new(tp: JsonType, value: Vec<u8>) -> Self

Creates a new JSON from the type and encoded bytes

pub fn get_type(&self) -> JsonType

Returns the JSON type

pub fn from_string(s: String) -> Result<Self>

Creates a string JSON from a String

pub fn from_str_val(s: &str) -> Result<Self>

Creates a string JSON from a &str

pub fn from_bool(b: bool) -> Result<Self>

Creates a literal JSON from a bool

pub fn from_u64(v: u64) -> Result<Self>

Creates a number JSON from a u64

pub fn from_f64(v: f64) -> Result<Self>

Creates a number JSON from a f64

pub fn from_i64(v: i64) -> Result<Self>

Creates a number JSON from an i64

pub fn from_ref_array(array: Vec<JsonRef<'_>>) -> Result<Self>

Creates a array JSON from a collection of JsonRef

pub fn from_array(array: Vec<Json>) -> Result<Self>

Creates a array JSON from a collection of Json

pub fn from_kv_pairs(entries: Vec<(&[u8], JsonRef<'_>)>) -> Result<Self>

Creates a object JSON from key-value pairs

pub fn from_object(map: BTreeMap<String, Json>) -> Result<Self>

Creates a object JSON from key-value pairs in BTreeMap

pub fn none() -> Result<Self>

Creates a null JSON

pub fn as_ref(&self) -> JsonRef<'_>

Returns a JsonRef points to the starting of encoded bytes

Trait Implementations

impl AsMySQLBool for Json

fn as_mysql_bool(&self, _context: &mut EvalContext) -> Result<bool>

Evaluates into a MySQL logic value.

impl ChunkedVec<Json> for ChunkedVecJson

fn from_slice(slice: &[Option<Json>]) -> Self

fn from_vec(data: Vec<Option<Json>>) -> Self

fn push(&mut self, value: Option<Json>)

fn is_empty(&self) -> bool

fn with_capacity(capacity: usize) -> Self

fn push_data(&mut self, value: Json)

fn push_null(&mut self)

fn len(&self) -> usize

fn truncate(&mut self, len: usize)

fn capacity(&self) -> usize

fn append(&mut self, other: &mut Self)

fn to_vec(&self) -> Vec<Option<Json>>

impl Clone for Json

fn clone(&self) -> Json

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl ConvertTo<Decimal> for Json

fn convert(&self, ctx: &mut EvalContext) -> Result<Decimal>

Port from TiDB’s types.ConvertJSONToDecimal

impl ConvertTo<Json> for i64

fn convert(&self, _: &mut EvalContext) -> Result<Json>

Converts the given value to T value

impl ConvertTo<Json> for f64

fn convert(&self, _: &mut EvalContext) -> Result<Json>

Converts the given value to T value

impl ConvertTo<Json> for Real

fn convert(&self, _: &mut EvalContext) -> Result<Json>

Converts the given value to T value

impl ConvertTo<Json> for Decimal

fn convert(&self, ctx: &mut EvalContext) -> Result<Json>

Converts the given value to T value

impl ConvertTo<Json> for Time

fn convert(&self, ctx: &mut EvalContext) -> Result<Json>

Converts the given value to T value

impl ConvertTo<Json> for Duration

fn convert(&self, _: &mut EvalContext) -> Result<Json>

Converts the given value to T value

impl ConvertTo<f64> for Json

fn convert(&self, ctx: &mut EvalContext) -> Result<f64>

Keep compatible with TiDB’s ConvertJSONToFloat function.

impl Debug for Json

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Json

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for Json

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for Json

impl EvaluableRet for Json

const EVAL_TYPE: EvalType

type ChunkedType = ChunkedVecJson

fn cast_chunk_into_vector_value(vec: ChunkedVecJson) -> VectorValue

Converts a vector of this concrete type into a VectorValue in the same type; panics if the varient mismatches.

impl From<Json> for ScalarValue

fn from(s: Json) -> ScalarValue

Performs the conversion.

impl From<Json> for Datum

fn from(data: Json) -> Datum

Performs the conversion.

impl FromStr for Json

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Ord for Json

fn cmp(&self, right: &Json) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Json> for Json

fn eq(&self, right: &Json) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<Json> for Json

fn partial_cmp(&self, right: &Json) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a> RawDatumDecoder<Json> for &'a [u8]

fn decode(
    self,
    _field_type: &FieldType,
    _ctx: &mut EvalContext
) -> Result<Option<Json>>

impl ToInt for Json

fn to_int(&self, ctx: &mut EvalContext, tp: FieldTypeTp) -> Result<i64>

Converts the given value to an i64

fn to_uint(&self, ctx: &mut EvalContext, tp: FieldTypeTp) -> Result<u64>

Converts the given value to an u64

impl ToString for Json

fn to_string(&self) -> String

Converts the given value to a String.

impl VectorValueExt<Json> for VectorValue

fn push(&mut self, v: Option<Json>)

The generic version for VectorValue::push_xxx().