Avro.Schema Class Reference

Base class for all schema types More...

Inheritance diagram for Avro.Schema:

Public Types
enum	Type {   Type.Null,   Type.Boolean,   Type.Int,   Type.Long,   Type.Float,   Type.Double,   Type.Bytes,   Type.String,   Type.Record,   Type.Enumeration,   Type.Array,   Type.Map,   Type.Union,   Type.Fixed,   Type.Error }
	Enum for schema types More...

Public Member Functions
override string	ToString ()
	Returns the canonical JSON representation of this schema. More...
string	GetProperty (string key)
	Returns the schema's custom property value given the property name More...
override int	GetHashCode ()
	Hash code function More...
virtual bool	CanRead (Schema writerSchema)
	Returns true if and only if data written using writerSchema can be read using the current schema according to the Avro resolution rules. More...

Static Public Member Functions
static Schema	Parse (string json)
	Parses a given JSON string to create a new schema object More...
static string	GetTypeString (Type type)
	Returns symbol name for the given schema type More...

Protected Member Functions
	Schema (Type type, PropertyMap props)
	Constructor for schema class More...
virtual internal void	WriteJsonFields (JsonTextWriter writer, SchemaNames names, string encspace)
	Default implementation for writing schema properties in JSON format More...
virtual internal void	WriteJson (JsonTextWriter writer, SchemaNames names, string encspace)
	Writes schema object in JSON format More...

Static Protected Member Functions
static bool	areEqual (object o1, object o2)
	Compares two objects, null is equal to null More...
static int	getHashCode (object obj)
	Hash code helper function More...

Properties
Type	Tag [get]
	Schema type property More...
abstract string	Name [get]
	The name of this schema. More...

Detailed Description

Base class for all schema types

Definition at line 29 of file Schema.cs.

Member Enumeration Documentation

Type

enum Avro.Schema.Type

strong

Enum for schema types

Enumerator
Null
Boolean
Int
Long
Float
Double
Bytes
String
Record
Enumeration
Array
Map
Union
Fixed
Error

Definition at line 34 of file Schema.cs.

Constructor & Destructor Documentation

Schema()

Avro.Schema.Schema ( Type  type, PropertyMap  props  )

inlineprotected

Constructor for schema class

Parameters

type

Definition at line 67 of file Schema.cs.

Member Function Documentation

areEqual()

static bool Avro.Schema.areEqual ( object  o1, object  o2  )

inlinestaticprotected

Compares two objects, null is equal to null

Parameters

o1	first object
o2	second object

Returns

true if two objects are equal, false otherwise

Definition at line 291 of file Schema.cs.

CanRead()

virtual bool Avro.Schema.CanRead ( Schema  writerSchema )

inlinevirtual

Returns true if and only if data written using writerSchema can be read using the current schema according to the Avro resolution rules.

Parameters

writerSchema

The writer's schema to match against.

Returns

True if and only if the current schema matches the writer's.

Reimplemented in Avro.RecordSchema, Avro.EnumSchema, Avro.UnionSchema, Avro.FixedSchema, Avro.PrimitiveSchema, Avro.MapSchema, and Avro.ArraySchema.

Definition at line 283 of file Schema.cs.

GetHashCode()

override int Avro.Schema.GetHashCode ( )

inline

Hash code function

Returns

Definition at line 272 of file Schema.cs.

getHashCode()

static int Avro.Schema.getHashCode ( object  obj )

inlinestaticprotected

Hash code helper function

Parameters

obj

Returns

Definition at line 301 of file Schema.cs.

GetProperty()

string Avro.Schema.GetProperty ( string  key )

inline

Returns the schema's custom property value given the property name

Parameters

key	custom property name

Returns

custom property value

Definition at line 261 of file Schema.cs.

GetTypeString()

static string Avro.Schema.GetTypeString ( Type  type )

inlinestatic

Returns symbol name for the given schema type

Parameters

type	schema type

Returns

symbol name

Definition at line 226 of file Schema.cs.

Parse()

static Schema Avro.Schema.Parse ( string  json )

inlinestatic

Parses a given JSON string to create a new schema object

Parameters

json	JSON string

Returns

new Schema object

Definition at line 141 of file Schema.cs.

ToString()

override string Avro.Schema.ToString ( )

inline

Returns the canonical JSON representation of this schema.

Returns

The canonical JSON representation of this schema.

Definition at line 191 of file Schema.cs.

WriteJson()

virtual internal void Avro.Schema.WriteJson ( JsonTextWriter  writer, SchemaNames  names, string  encspace  )

inlineprotectedvirtual

Writes schema object in JSON format

Parameters

writer	JSON writer
names	list of named schemas already written
encspace	enclosing namespace of the schema

Reimplemented in Avro.PrimitiveSchema.

Definition at line 248 of file Schema.cs.

WriteJsonFields()

virtual internal void Avro.Schema.WriteJsonFields ( JsonTextWriter  writer, SchemaNames  names, string  encspace  )

inlineprotectedvirtual

Default implementation for writing schema properties in JSON format

Parameters

writer	JSON writer
names	list of named schemas already written
encspace	enclosing namespace of the schema

Definition at line 238 of file Schema.cs.

Property Documentation

Name

abstract string Avro.Schema.Name

get

The name of this schema.

If this is a named schema such as an enum, it returns the fully qualified name for the schema. For other schemas, it returns the type of the schema.

Definition at line 77 of file Schema.cs.

Tag

Type Avro.Schema.Tag

get

Schema type property

Definition at line 56 of file Schema.cs.

---

The documentation for this class was generated from the following file:

• _build/public-os_ubuntu24.04-arch_amd64-cc_gcc_13.3.0/install/Avro/src/apache/main/Schema/Schema.cs