Contains meta data about a Tuple. Schemas are immutable: once constructed they may not be changed.

Namespace: StreamBase.SB
Assembly: StreamBase.SB.Client (in StreamBase.SB.Client.dll) Version: 11.0.0.0

Collapse imageSyntax

         
 C#  Visual Basic  Visual C++ 
public class Schema : ICloneable, IDisposable
Public Class Schema _
	Implements ICloneable, IDisposable
public ref class Schema : ICloneable, IDisposable

Collapse imageMembers

         
 All Members  Properties   Methods  
 Public

 Protected
 Instance

 Static 
 Declared

 Inherited
 XNA Framework Only 

 .NET Compact Framework Only 

 MemberDescription
Clone()()()()
Clone this Schema
CreateField(String, CompleteDataType)
Create a field of the specified name and type.
CreateFunctionField(String, Schema, CompleteDataType)
Create a function field of the specified name, argument list and return type.
CreateListField(String, CompleteDataType)
Create a list field of the specified name and element type.
CreateTupleField(String, Schema)
Create a tuple field of the specified name and schema.
Equals(Object)
Returns true if this Schema is equal to the given one.
(Overrides Object..::..Equals(Object).)
Fields
An array of Field objects corresponding to the fields in the schema.
GetField(Int32)
Gets the Field at the specified (zero-based) index.
GetField(String)
Gets the Field with the specified name
GetFieldCount()()()()
Returns the number of fields in the schema.
GetFieldIndex(String)
Returns the index of the field with a particular name, or -1 if there is no such field.
GetFields()()()()
Return an array of Field objects corresponding to the fields in the schema.
GetFieldTypes()()()()
A utility function to speed up multiple accesses to field types of a schema in contexts where multiple tuples are processed; the function should be called outside of for loops processing tuples and their fields
GetHash()()()()
Return the hash for this schema generated by the server.
GetHashCode()()()()
Hash function for this type.
(Overrides Object..::..GetHashCode()()()().)
GetName()()()()
Returns the name of the schema.
Note:
Generally, when constructing a Schema in client or adapter code the name parameter should not be set, and null should be used. This parameter should not be confused with the concept of Named Schemas (schemas defined for sharing and reuse by StreamBase applications in the Definitions tab of the EventFlow editor or using the StreamSQL CREATE SCHEMA). Use of non-null schema names in the context of custom operators and adapters can yield unpredictable behavior.
GetNumFields()()()()
Returns the number of fields in the schema.
GetType()()()()
Gets the Type of the current instance.
(Inherited from Object.)
HasField(String)
Return true if this Schema has a Field by the given name.
Item[([( Int32])])
Item[([( String])])
Name
The name of the schema.
Note:
Generally, when constructing a Schema in client or adapter code the name parameter should not be set, and null should be used. This parameter should not be confused with the concept of Named Schemas (schemas defined for sharing and reuse by StreamBase applications in the Definitions tab of the EventFlow editor or using the StreamSQL CREATE SCHEMA). Use of non-null schema names in the context of custom operators and adapters can yield unpredictable behavior.
SameFieldsAs(Schema)
Returns true if this schema has the same field Names and Types in the same order as another Schema
SameFieldTypes(Schema)
Returns true if this schema has the same field types in the same order as another Schema.
ToHumanString()()()()
Returns a description of the Schema using a SSQL-style format.
ToString()()()()
Returns the name of the schema.
(Overrides Object..::..ToString()()()().)
ToStringWithFields()()()()
Returns a string representation of the schema.

Collapse imageInheritance Hierarchy

System..::..Object
  StreamBase.SB..::..Schema

Collapse imageSee Also