Schema Members

NFX Class Library

[This is preliminary documentation and is subject to change.]

The Schema type exposes the following members.

Constructors

	Name	Description
	Schema(String, Schema FieldDef )	Initializes a new instance of the Schema class
	Schema(String, Boolean, Schema FieldDef )	Initializes a new instance of the Schema class
	Schema(String, Boolean, IEnumerable Schema FieldDef , IEnumerable TableAttribute )	Initializes a new instance of the Schema class
	Schema(String, Boolean, IEnumerable TableAttribute , Schema FieldDef )	Initializes a new instance of the Schema class

Methods

	Name	Description
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	FromJSON(String, Boolean)
	FromJSON(JSONDataMap, Boolean)
	GetEnumerator
	GetFieldDefByIndex	Finds fielddef by name or throws if name is not found
	GetFieldDefByName	Finds fielddef by name or throws if name is not found
	GetFieldMembers	Gets all property members of TypedRow that are tagged as [Field]
	GetForTypedRow(Type)	Returns schema instance for the TypedRow instance by fetching schema object from cache or creating it if it has not been cached yet
	GetForTypedRow(TypedRow)	Returns schema instance for the TypedRow instance by fetching schema object from cache or creating it if it has not been cached yet
	GetForTypedRow TRow	Returns schema instance for the TypedRow instance by fetching schema object from cache or creating it if it has not been cached yet
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetKeyFieldDefsForTarget	Returns FieldDefs in their order within rows that are declared as key fields for particular target
	GetTableAttrForTarget	Returns a TableAttribute that matches the supplied targetName, or if one was not defined then returns TableAttribute which matches any target or null
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IsEquivalentTo	Performs logical equivalence testing of two schemas
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	(Overrides Object ToString .)
	WriteAsJSON	Writes schema as JSON. Do not call this method directly, instead call rowset.ToJSON() or use JSONWriter class

Extension Methods

	Name	Description
	AsBool	(Defined by ObjectValueConversion.)
	AsByte	(Defined by ObjectValueConversion.)
	AsChar	(Defined by ObjectValueConversion.)
	AsDateTime	Overloaded. (Defined by ObjectValueConversion.)
	AsDateTime(DateTime, ConvertErrorHandling)	Overloaded. (Defined by ObjectValueConversion.)
	AsDecimal	(Defined by ObjectValueConversion.)
	AsDouble	(Defined by ObjectValueConversion.)
	AsEnum TEnum	(Defined by ObjectValueConversion.)
	AsFloat	(Defined by ObjectValueConversion.)
	AsGDID	Overloaded. (Defined by ObjectValueConversion.)
	AsGDID(GDID, ConvertErrorHandling)	Overloaded. (Defined by ObjectValueConversion.)
	AsGDIDSymbol	Overloaded. (Defined by ObjectValueConversion.)
	AsGDIDSymbol(GDIDSymbol, ConvertErrorHandling)	Overloaded. (Defined by ObjectValueConversion.)
	AsGUID	(Defined by ObjectValueConversion.)
	AsInt	(Defined by ObjectValueConversion.)
	AsJSONConfig	(Defined by ObjectValueConversion.)
	AsLaconicConfig	(Defined by ObjectValueConversion.)
	AsLong	(Defined by ObjectValueConversion.)
	AsLookAheadEnumerable Schema FieldDef	(Defined by LookAheadExtensions.)
	AsNonNullOrEmptyString	(Defined by ObjectValueConversion.)
	AsNullableBool	(Defined by ObjectValueConversion.)
	AsNullableByte	(Defined by ObjectValueConversion.)
	AsNullableChar	(Defined by ObjectValueConversion.)
	AsNullableDateTime	(Defined by ObjectValueConversion.)
	AsNullableDecimal	(Defined by ObjectValueConversion.)
	AsNullableDouble	(Defined by ObjectValueConversion.)
	AsNullableEnum TEnum	(Defined by ObjectValueConversion.)
	AsNullableFloat	(Defined by ObjectValueConversion.)
	AsNullableGDID	(Defined by ObjectValueConversion.)
	AsNullableGDIDSymbol	(Defined by ObjectValueConversion.)
	AsNullableGUID	(Defined by ObjectValueConversion.)
	AsNullableInt	(Defined by ObjectValueConversion.)
	AsNullableLong	(Defined by ObjectValueConversion.)
	AsNullableSByte	(Defined by ObjectValueConversion.)
	AsNullableShort	(Defined by ObjectValueConversion.)
	AsNullableTimeSpan	(Defined by ObjectValueConversion.)
	AsNullableUInt	(Defined by ObjectValueConversion.)
	AsNullableULong	(Defined by ObjectValueConversion.)
	AsNullableUShort	(Defined by ObjectValueConversion.)
	AsSByte	(Defined by ObjectValueConversion.)
	AsShort	(Defined by ObjectValueConversion.)
	AsString	(Defined by ObjectValueConversion.)
	AsTimeSpan	Overloaded. (Defined by ObjectValueConversion.)
	AsTimeSpan(TimeSpan, ConvertErrorHandling)	Overloaded. (Defined by ObjectValueConversion.)
	AsUInt	(Defined by ObjectValueConversion.)
	AsULong	(Defined by ObjectValueConversion.)
	AsUri	(Defined by ObjectValueConversion.)
	AsUShort	(Defined by ObjectValueConversion.)
	AsXMLConfig	(Defined by ObjectValueConversion.)
	Distinct Schema FieldDef, TKey	(Defined by CollectionUtils.)
	FirstMax Schema FieldDef, TComparand (Func Schema FieldDef, TComparand )	Overloaded. (Defined by CollectionUtils.)
	FirstMax Schema FieldDef, TComparand (Func Schema FieldDef, TComparand , TComparand )	Overloaded. (Defined by CollectionUtils.)
	FirstMin Schema FieldDef, TComparand (Func Schema FieldDef, TComparand )	Overloaded. (Defined by CollectionUtils.)
	FirstMin Schema FieldDef, TComparand (Func Schema FieldDef, TComparand , TComparand )	Overloaded. (Defined by CollectionUtils.)
	FirstOrAnyOrDefault Schema FieldDef	Tries to find the first element that matches the predicate and returns it, otherwise returns the first element found or default (i.e. null) (Defined by CollectionUtils.)
	ForEach Schema FieldDef (Action Schema FieldDef )	Overloaded. Runs some method over each element of src sequence (Defined by CollectionUtils.)
	ForEach Schema FieldDef (Action Schema FieldDef, Int32 )	Overloaded. Runs some method over each element of src sequence (Defined by CollectionUtils.)
	SkipLast Schema FieldDef	Overloaded. Takes all elements except for last element from the given source (Defined by CollectionUtils.)
	SkipLast Schema FieldDef (Int32)	Overloaded. Takes all but last N elements from the source (Defined by CollectionUtils.)
	ToErlObject	Overloaded. Try to convert .NET native object type to corresponding Erlang term. Throw exception if conversion is not possible (Defined by ErlObject.)
	ToErlObject(ErlTypeOrder, Boolean)	Overloaded. Try to convert .NET native object type to corresponding Erlang term of given type. Throw exception if conversion is not possible (Defined by ErlObject.)
	ToJSON(JSONWritingOptions)	Overloaded. Serializes object into JSON string (Defined by JSONExtensions.)
	ToJSON(TextWriter, JSONWritingOptions)	Overloaded. Serializes object into JSON format using provided TextWriter (Defined by JSONExtensions.)
	ToJSON(Stream, JSONWritingOptions, Encoding)	Overloaded. Serializes object into JSON format using provided stream and optional encoding (Defined by JSONExtensions.)

Fields

	Name	Description
	EXTRA_SUPPORTS_DELETE_ATTR
	EXTRA_SUPPORTS_INSERT_ATTR
	EXTRA_SUPPORTS_UPDATE_ATTR

Properties

	Name	Description
	AnyTargetKeyFieldDefs	Returns FieldDefs in their order within rows that are declared as key fields in ANY_TARGET
	AnyVisibleFieldDefs	Returns FieldDefs in their order within rows as
	ExtraData	Returns Extra data that may be associated with schema by various providers. The field is lazily allocated
	FieldCount	Returns field count
	FieldDefs	Returns FieldDefs in their order within rows that this schema describes
	Item Int32	Returns a field definition by a positional index within the row
	Item String	Returns a field definition by a unique case-insensitive field name within schema
	Name	For TypedRows, returns a unique fully-qualified row type name, whichs is the global identifier of this schema instance
	ReadOnly	Specifies that target that this schema represents (i.e. db table) is not updatable so DataStore will not be able to save row changes made in ram
	SchemaEquivalenceEqualityComparer	Returns an instance of IEqualityComparer(Schema) that performs logical equivalence testing
	TableAttrs	Returns table-level attributes
	TypedRowType	Returns a type of TypedRow if schema was created for TypedRow, or null

Explicit Interface Implementations

	Name	Description
	IEnumerable GetEnumerator