Struct JsonDataType 

pub struct JsonDataType {
    pub storage_format: JsonStorageFormat,
    pub validate_on_insert: bool,
}

JSON/Semi-structured data type.

Database mapping details:

Platform	Type	Notes
PostgreSQL	JSON or JSONB	JSONB supports GIN indexing and is faster for queries
SQL Server	NVARCHAR(MAX) with JSON functions (2016+), or native JSON (2025+)
Snowflake	VARIANT	Native semi-structured type, supports nested data and arrays
Databricks	STRING with JSON functions, or VARIANT
ClickHouse	JSON (experimental/production), or String with JSON functions
CitusDB	Same as PostgreSQL (JSONB recommended)

Storage Formats

• Binary (default): Normalized storage, faster queries, indexable. Maps to JSONB in PostgreSQL, VARIANT in Snowflake.
• Text: Preserves whitespace, key order, and duplicate keys. Maps to JSON in PostgreSQL, NVARCHAR(MAX) in SQL Server.

Example

use razeri_plugin_contract::DataType;
use razeri_plugin_contract::data_type::{JsonDataType, JsonStorageFormat};

// Binary format (recommended) - uses JSONB in PostgreSQL, VARIANT in Snowflake
let json_binary = JsonDataType::default();
assert_eq!(json_binary.storage_format, JsonStorageFormat::Binary);

// Text format - preserves original formatting
let json_text = JsonDataType::text();
assert_eq!(json_text.storage_format, JsonStorageFormat::Text);

// Via DataType convenience
let data = DataType::json();

Fields

storage_format: JsonStorageFormat

Storage format preference (binary is recommended for most use cases).

validate_on_insert: bool

Whether to validate JSON on insert (if supported by the database).

PostgreSQL always validates, some other databases may not.

Implementations

impl JsonDataType

pub fn new() -> Self

Creates a new JSON type with binary storage format (JSONB in PostgreSQL).

This is the recommended format for most use cases as it enables:

• Faster query performance
• GIN indexing support (PostgreSQL)
• Normalized storage (no duplicate keys, sorted keys)

Example

use razeri_plugin_contract::data_type::{JsonDataType, JsonStorageFormat};

let json = JsonDataType::new();
assert_eq!(json.storage_format, JsonStorageFormat::Binary);
assert!(!json.validate_on_insert);

pub fn text() -> Self

Creates a JSON type with text storage format.

Use this when you need to preserve:

• Original whitespace formatting
• Original key order
• Duplicate keys (not recommended but sometimes required)

Example

use razeri_plugin_contract::data_type::{JsonDataType, JsonStorageFormat};

let json = JsonDataType::text();
assert_eq!(json.storage_format, JsonStorageFormat::Text);
assert!(json.validate_on_insert);

pub fn binary() -> Self

Creates a JSON type with binary storage format.

Example

use razeri_plugin_contract::data_type::{JsonDataType, JsonStorageFormat};

let json = JsonDataType::binary();
assert_eq!(json.storage_format, JsonStorageFormat::Binary);
assert!(json.validate_on_insert);

pub fn with_validation(self, validate: bool) -> Self

Sets whether to validate JSON on insert.

Example

use razeri_plugin_contract::data_type::JsonDataType;

let json = JsonDataType::new().with_validation(false);
assert!(!json.validate_on_insert);

Trait Implementations

impl Clone for JsonDataType

fn clone(&self) -> JsonDataType

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for JsonDataType

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

Formats the value using the given formatter.

impl Default for JsonDataType

fn default() -> JsonDataType

Returns the “default value” for a type.

impl Eq for JsonDataType

impl Hash for JsonDataType

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for JsonDataType

fn eq(&self, other: &JsonDataType) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for JsonDataType