Class for record schemas More...

Inheritance diagram for Avro.RecordSchema:

Collaboration diagram for Avro.RecordSchema:

Public Member Functions
bool	Contains (string fieldName)
	Returns true if and only if the record contains a field by the given name. More...

bool	TryGetField (string fieldName, out Field field)

bool	TryGetFieldAlias (string fieldName, out Field field)

IEnumerator< Field >	GetEnumerator ()
	Returns an enumerator which enumerates over the fields of this record schema More...

override bool	Equals (object obj)
	Compares equality of two record schemas More...

override int	GetHashCode ()
	Hash code function More...

override bool	CanRead (Schema writerSchema)
	Checks if this schema can read data written by the given schema. More...

Public Member Functions inherited from Avro.Schema
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...

Protected Member Functions
internal override void	WriteJsonFields (Newtonsoft.Json.JsonTextWriter writer, SchemaNames names, string encspace)
	Writes the records schema in JSON format More...

Protected Member Functions inherited from Avro.NamedSchema
	NamedSchema (Type type, SchemaName name, IList< SchemaName > aliases, PropertyMap props, SchemaNames names)
	Constructor for named schema class More...

bool	InAliases (SchemaName name)

internal override void	WriteJson (Newtonsoft.Json.JsonTextWriter writer, SchemaNames names, string encspace)
	Writes named schema in JSON format More...

internal override void	WriteJsonFields (Newtonsoft.Json.JsonTextWriter writer, SchemaNames names, string encspace)
	Writes named schema in JSON format More...

Protected Member Functions inherited from Avro.Schema
	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...

Properties
List< Field >	Fields `[get]`
	List of fields in the record More...

int	Count `[get]`
	Number of fields in the record More...

Field?	this[string name] `[get]`
	Returns the field with the given name. More...

Properties inherited from Avro.NamedSchema
SchemaName	SchemaName `[get]`
	Name of the schema, contains name, namespace and enclosing namespace More...

override string	Name `[get]`
	Name of the schema More...

string	Namespace `[get]`
	Namespace of the schema More...

string	Fullname `[get]`
	Namespace.Name of the schema More...

Properties inherited from Avro.Schema
Type	Tag `[get]`
	Schema type property More...

abstract string	Name `[get]`
	The name of this schema. More...

Additional Inherited Members
Public Types inherited from Avro.Schema
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...

Static Public Member Functions inherited from Avro.Schema
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...

Static Protected Member Functions inherited from Avro.NamedSchema
static SchemaName	GetName (JToken jtok, string encspace)
	Parses the name and namespace from the given JSON schema object then creates SchemaName object including the given enclosing namespace More...

static IList< SchemaName >	GetAliases (JToken jtok, string space, string encspace)
	Parses the 'aliases' property from the given JSON token More...

Static Protected Member Functions inherited from Avro.Schema
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...

Detailed Description

Class for record schemas

Definition at line 31 of file RecordSchema.cs.

Member Function Documentation

◆ CanRead()

override bool Avro.RecordSchema.CanRead ( Schema writerSchema )

inlinevirtual

Checks if this schema can read data written by the given schema.

Used for decoding data.

Parameters

writerSchema writer schema

Returns: true if this and writer schema are compatible based on the AVRO specification, false otherwise

Reimplemented from Avro.Schema.

Definition at line 267 of file RecordSchema.cs.

◆ Contains()

bool Avro.RecordSchema.Contains ( string fieldName )

inline

Returns true if and only if the record contains a field by the given name.

Parameters

fieldName The name of the field

Returns: true if the field exists, false otherwise

Definition at line 175 of file RecordSchema.cs.

◆ Equals()

override bool Avro.RecordSchema.Equals ( object obj )

inline

Compares equality of two record schemas

Parameters

obj	record schema to compare against this schema

Returns: true if the two schemas are equal, false otherwise

Definition at line 228 of file RecordSchema.cs.

◆ GetEnumerator()

IEnumerator<Field> Avro.RecordSchema.GetEnumerator ( )

inline

Returns an enumerator which enumerates over the fields of this record schema

Returns: Enumerator over the field in the order of their definition

Definition at line 193 of file RecordSchema.cs.

◆ GetHashCode()

override int Avro.RecordSchema.GetHashCode ( )

inline

Hash code function

Returns

Definition at line 251 of file RecordSchema.cs.

◆ TryGetField()

bool Avro.RecordSchema.TryGetField	(	string	fieldName,
		out Field	field
	)

inline

Definition at line 180 of file RecordSchema.cs.

◆ TryGetFieldAlias()

bool Avro.RecordSchema.TryGetFieldAlias	(	string	fieldName,
		out Field	field
	)

inline

Definition at line 184 of file RecordSchema.cs.

◆ WriteJsonFields()

internal override void Avro.RecordSchema.WriteJsonFields	(	Newtonsoft.Json.JsonTextWriter	writer,
		SchemaNames	names,
		string	encspace
	)

inlineprotected

Writes the records schema in JSON format

Parameters

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

Definition at line 204 of file RecordSchema.cs.

Property Documentation

◆ Count

int Avro.RecordSchema.Count

get

Number of fields in the record

Definition at line 41 of file RecordSchema.cs.

◆ Fields

List<Field> Avro.RecordSchema.Fields

get

List of fields in the record

Definition at line 36 of file RecordSchema.cs.

◆ this[string name]

Field? Avro.RecordSchema.this[string name]

get

Returns the field with the given name.

Parameters

name	field name

Returns: Field object

Definition at line 161 of file RecordSchema.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/RecordSchema.cs

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ CanRead()

◆ Contains()

◆ Equals()

◆ GetEnumerator()

◆ GetHashCode()

◆ TryGetField()

◆ TryGetFieldAlias()

◆ WriteJsonFields()

Property Documentation

◆ Count

◆ Fields

◆ this[string name]