Bin2DataStreamer

Overview

Bin2DataStreamer implements a data streamer that uses a proprietary binary format for streaming data across the network. This format is compatible with the Delphi version of Data Abstract.

The Bin2DataStreamer is provided as an alternative to the existing BinDataStreamer, which, of course, is still supported for backward compatibility.

Benefits

  • New streaming format: better defined and much more efficient, especially for large data transfer.
  • Reduction of network traffic: SendReducedDelta mode, pre-validation of the stream structure and non-transmission of null values.
  • Bin2DataStreamer has additional optimization for cases when OnBeforeFieldValueSerialization and OnWriteFieldValue events are not used. Changing of BufferSize property may also increase performance.

Location

 

constructor

 

constructor

 

Bin2DataStreamer()

 

init()

 

Sub New()

constructor (IContainer)

 

constructor(container: IContainer)

 

Bin2DataStreamer(IContainer container)

 

init(_ container: IContainer)

 

Sub New(container As IContainer)

Parameters:

  • container:

constructor (Stream, StreamerInitialization)

 

constructor(dataStream: Stream; mode: StreamerInitialization)

 

Bin2DataStreamer(Stream dataStream, StreamerInitialization mode)

 

init(_ dataStream: Stream, _ mode: StreamerInitialization)

 

Sub New(dataStream As Stream, mode As StreamerInitialization)

Parameters:

  • dataStream:
  • mode:

BeginWriteDataReader    (declared in DataStreamer)

 

method BeginWriteDataReader(tableSchema: SchemaDataTable; fields: array of String; maxRecords: Int32; includeSchema: Boolean): DataForAppend

 

DataForAppend BeginWriteDataReader(SchemaDataTable tableSchema, String[] fields, Int32 maxRecords, Boolean includeSchema)

 

func BeginWriteDataReader(_ tableSchema: SchemaDataTable, _ fields: String..., _ maxRecords: Int32, _ includeSchema: Boolean) -> DataForAppend

 

Function BeginWriteDataReader(tableSchema As SchemaDataTable, fields As String(), maxRecords As Int32, includeSchema As Boolean) As DataForAppend

Parameters:

  • tableSchema:
  • fields:
  • maxRecords:
  • includeSchema:

CountElements    (declared in DataStreamer)

 

method CountElements(elementType: StreamElementType): Int32

 

Int32 CountElements(StreamElementType elementType)

 

func CountElements(_ elementType: StreamElementType) -> Int32

 

Function CountElements(elementType As StreamElementType) As Int32

Parameters:

  • elementType:

DataReaderNeedsSchema    (declared in DataStreamer)

 

property DataReaderNeedsSchema: Boolean read;

 

Boolean DataReaderNeedsSchema { get; }

 

var DataReaderNeedsSchema: Boolean { get{} }

 

ReadOnly Property DataReaderNeedsSchema() As Boolean

DefaultStringEncoding

 

property DefaultStringEncoding: Encoding read write;

 

Encoding DefaultStringEncoding { get; set; }

 

var DefaultStringEncoding: Encoding { get{} set{} }

 

Property DefaultStringEncoding() As Encoding

Dispose  protected    (declared in DataStreamer)

 

method Dispose(disposing: Boolean)

 

void Dispose(Boolean disposing)

 

func Dispose(_ disposing: Boolean)

 

Sub Dispose(disposing As Boolean)

Parameters:

  • disposing:

Elements    (declared in DataStreamer)

 

property Elements: Dictionary<String, StreamElementInfo> read;

 

Dictionary<String, StreamElementInfo> Elements { get; }

 

var Elements: Dictionary<String, StreamElementInfo> { get{} }

 

ReadOnly Property Elements() As Dictionary<String, StreamElementInfo>

EndWriteDataReader    (declared in DataStreamer)

 

method EndWriteDataReader(data: DataForAppend): Int32

 

Int32 EndWriteDataReader(DataForAppend data)

 

func EndWriteDataReader(_ data: DataForAppend) -> Int32

 

Function EndWriteDataReader(data As DataForAppend) As Int32

Parameters:

  • data:

FinalizeStreamer    (declared in DataStreamer)

Finalize the read/writing of data. This method should be called after all elements are written or when reading is complete.

 

method FinalizeStreamer

 

void FinalizeStreamer()

 

func FinalizeStreamer()

 

Sub FinalizeStreamer()

GetDataReader    (declared in DataStreamer)

 

method GetDataReader(tableName: String): IDataReader

 

IDataReader GetDataReader(String tableName)

 

func GetDataReader(_ tableName: String) -> IDataReader

 

Function GetDataReader(tableName As String) As IDataReader

Parameters:

  • tableName:

GetLoggedDeltaFields  protected    (declared in DataStreamer)

 

class method GetLoggedDeltaFields(delta: Delta; out fields: SchemaField; out mapping: Int32)

 

static void GetLoggedDeltaFields(Delta delta, out SchemaField fields, out Int32 mapping)

 

static func GetLoggedDeltaFields(_ delta: Delta, _ fields: inout SchemaField, _ mapping: inout Int32)

 

Shared Sub GetLoggedDeltaFields(delta As Delta, <OutAttribute> ByRef fields As SchemaField, <OutAttribute> ByRef mapping As Int32)

Parameters:

  • delta:
  • fields:
  • mapping:

InitializationMode  protected    (declared in DataStreamer)

 

property InitializationMode: StreamerInitialization read;

 

StreamerInitialization InitializationMode { get; }

 

var InitializationMode: StreamerInitialization { get{} }

 

ReadOnly Property InitializationMode() As StreamerInitialization

InitializeStreamer    (declared in DataStreamer)

 

method InitializeStreamer(dataStream: Stream; mode: StreamerInitialization)

 

void InitializeStreamer(Stream dataStream, StreamerInitialization mode)

 

func InitializeStreamer(_ dataStream: Stream, _ mode: StreamerInitialization)

 

Sub InitializeStreamer(dataStream As Stream, mode As StreamerInitialization)

Parameters:

  • dataStream:
  • mode:

ItemExistInArray  protected    (declared in DataStreamer)

 

class method ItemExistInArray(data: array of String; item: String): Boolean

 

static Boolean ItemExistInArray(String[] data, String item)

 

static func ItemExistInArray(_ data: String..., _ item: String) -> Boolean

 

Shared Function ItemExistInArray(data As String(), item As String) As Boolean

Parameters:

  • data:
  • item:

ListElements    (declared in DataStreamer)

Returns all elements in the stream that have their ElementType matching the given parameter.

 

method ListElements(elementType: StreamElementType): List<StreamElementInfo>

 

List<StreamElementInfo> ListElements(StreamElementType elementType)

 

func ListElements(_ elementType: StreamElementType) -> List<StreamElementInfo>

 

Function ListElements(elementType As StreamElementType) As List<StreamElementInfo>

Parameters:

  • elementType:

NeedIncludeValuesToStream  protected    (declared in DataStreamer)

 

class method NeedIncludeValuesToStream(oldValue: Object; newValue: Object; isReducedDelta: Boolean; isPrimaryKey: Boolean; out includeOld: Boolean; out includeNew: Boolean)

 

static void NeedIncludeValuesToStream(Object oldValue, Object newValue, Boolean isReducedDelta, Boolean isPrimaryKey, out Boolean includeOld, out Boolean includeNew)

 

static func NeedIncludeValuesToStream(_ oldValue: Object, _ newValue: Object, _ isReducedDelta: Boolean, _ isPrimaryKey: Boolean, _ includeOld: inout Boolean, _ includeNew: inout Boolean)

 

Shared Sub NeedIncludeValuesToStream(oldValue As Object, newValue As Object, isReducedDelta As Boolean, isPrimaryKey As Boolean, <OutAttribute> ByRef includeOld As Boolean, <OutAttribute> ByRef includeNew As Boolean)

Parameters:

  • oldValue:
  • newValue:
  • isReducedDelta:
  • isPrimaryKey:
  • includeOld:
  • includeNew:

ReadDataTable (Stream, String, DataTable)    (declared in DataStreamer)

 

method ReadDataTable(dataStream: Stream; tableName: String; destination: DataTable)

 

void ReadDataTable(Stream dataStream, String tableName, DataTable destination)

 

func ReadDataTable(_ dataStream: Stream, _ tableName: String, _ destination: DataTable)

 

Sub ReadDataTable(dataStream As Stream, tableName As String, destination As DataTable)

Parameters:

  • dataStream:
  • tableName:
  • destination:

ReadDataTable (Stream, String, DataTable, Boolean)    (declared in DataStreamer)

 

method ReadDataTable(dataStream: Stream; tableName: String; destination: DataTable; applySchema: Boolean)

 

void ReadDataTable(Stream dataStream, String tableName, DataTable destination, Boolean applySchema)

 

func ReadDataTable(_ dataStream: Stream, _ tableName: String, _ destination: DataTable, _ applySchema: Boolean)

 

Sub ReadDataTable(dataStream As Stream, tableName As String, destination As DataTable, applySchema As Boolean)

Parameters:

  • dataStream:
  • tableName:
  • destination:
  • applySchema:

ReadDataTable (Stream, String, DataTable, Boolean, Boolean)    (declared in DataStreamer)

 

method ReadDataTable(dataStream: Stream; tableName: String; destination: DataTable; applySchema: Boolean; loadRecords: Boolean)

 

void ReadDataTable(Stream dataStream, String tableName, DataTable destination, Boolean applySchema, Boolean loadRecords)

 

func ReadDataTable(_ dataStream: Stream, _ tableName: String, _ destination: DataTable, _ applySchema: Boolean, _ loadRecords: Boolean)

 

Sub ReadDataTable(dataStream As Stream, tableName As String, destination As DataTable, applySchema As Boolean, loadRecords As Boolean)

Parameters:

  • dataStream:
  • tableName:
  • destination:
  • applySchema:
  • loadRecords:

ReadDataTable (String, DataTable, Boolean, Boolean)    (declared in DataStreamer)

 

method ReadDataTable(tableName: String; destination: DataTable; applySchema: Boolean; loadData: Boolean)

 

void ReadDataTable(String tableName, DataTable destination, Boolean applySchema, Boolean loadData)

 

func ReadDataTable(_ tableName: String, _ destination: DataTable, _ applySchema: Boolean, _ loadData: Boolean)

 

Sub ReadDataTable(tableName As String, destination As DataTable, applySchema As Boolean, loadData As Boolean)

Parameters:

  • tableName:
  • destination:
  • applySchema:
  • loadData:

ReadDataTableSchema    (declared in DataStreamer)

Reads the schema of a DataTable and returns it.

 

method ReadDataTableSchema(tableName: String): SchemaDataTable

 

SchemaDataTable ReadDataTableSchema(String tableName)

 

func ReadDataTableSchema(_ tableName: String) -> SchemaDataTable

 

Function ReadDataTableSchema(tableName As String) As SchemaDataTable

Parameters:

  • tableName:

ReadDelta (Delta)    (declared in DataStreamer)

This method will return a delta from the stream. If there is no delta by the name passed it will throw an exception.

 

method ReadDelta(destination: Delta)

 

void ReadDelta(Delta destination)

 

func ReadDelta(_ destination: Delta)

 

Sub ReadDelta(destination As Delta)

Parameters:

  • destination:

ReadDelta (Schema, String): Delta    (declared in DataStreamer)

 

method ReadDelta(schema: Schema; tableName: String): Delta

 

Delta ReadDelta(Schema schema, String tableName)

 

func ReadDelta(_ schema: Schema, _ tableName: String) -> Delta

 

Function ReadDelta(schema As Schema, tableName As String) As Delta

Parameters:

  • schema:
  • tableName:

SendReducedDelta

Determines if streamer would use Reduced Delta feature or not. If this feature is on, sending data packets will only contain fields that are either part of the Primary Key (needed to locate the record that will be updated), and/or the fields that have actually been changed.

 

property SendReducedDelta: Boolean read write;

 

Boolean SendReducedDelta { get; set; }

 

var SendReducedDelta: Boolean { get{} set{} }

 

Property SendReducedDelta() As Boolean

StreamType

 

property StreamType: StreamType read;

 

StreamType StreamType { get; }

 

var StreamType: StreamType { get{} }

 

ReadOnly Property StreamType() As StreamType

WriteDataReader (IDataReader, SchemaDataTable)    (declared in DataStreamer)

Writes the contents of a DataReader and the associated schema to the stream.

 

method WriteDataReader(reader: IDataReader; tableSchema: SchemaDataTable)

 

void WriteDataReader(IDataReader reader, SchemaDataTable tableSchema)

 

func WriteDataReader(_ reader: IDataReader, _ tableSchema: SchemaDataTable)

 

Sub WriteDataReader(reader As IDataReader, tableSchema As SchemaDataTable)

Parameters:

  • reader:
  • tableSchema:

WriteDataReader (IDataReader, SchemaDataTable, array of String, Int32, Boolean, SchemaColumnMappingCollection)    (declared in DataStreamer)

 

method WriteDataReader(reader: IDataReader; tableSchema: SchemaDataTable; fields: array of String; maxRecords: Int32; includeSchema: Boolean; columnMapping: SchemaColumnMappingCollection)

 

void WriteDataReader(IDataReader reader, SchemaDataTable tableSchema, String[] fields, Int32 maxRecords, Boolean includeSchema, SchemaColumnMappingCollection columnMapping)

 

func WriteDataReader(_ reader: IDataReader, _ tableSchema: SchemaDataTable, _ fields: String..., _ maxRecords: Int32, _ includeSchema: Boolean, _ columnMapping: SchemaColumnMappingCollection)

 

Sub WriteDataReader(reader As IDataReader, tableSchema As SchemaDataTable, fields As String(), maxRecords As Int32, includeSchema As Boolean, columnMapping As SchemaColumnMappingCollection)

Parameters:

  • reader:
  • tableSchema:
  • fields:
  • maxRecords:
  • includeSchema:
  • columnMapping:

WriteDataReader (IDataReader, SchemaDataTable, Int32)    (declared in DataStreamer)

 

method WriteDataReader(reader: IDataReader; tableSchema: SchemaDataTable; maxRecords: Int32)

 

void WriteDataReader(IDataReader reader, SchemaDataTable tableSchema, Int32 maxRecords)

 

func WriteDataReader(_ reader: IDataReader, _ tableSchema: SchemaDataTable, _ maxRecords: Int32)

 

Sub WriteDataReader(reader As IDataReader, tableSchema As SchemaDataTable, maxRecords As Int32)

Parameters:

  • reader:
  • tableSchema:
  • maxRecords:

WriteDataReader (IDataReader, SchemaDataTable, Int32, Boolean)    (declared in DataStreamer)

 

method WriteDataReader(reader: IDataReader; tableSchema: SchemaDataTable; maxRecords: Int32; includeSchema: Boolean)

 

void WriteDataReader(IDataReader reader, SchemaDataTable tableSchema, Int32 maxRecords, Boolean includeSchema)

 

func WriteDataReader(_ reader: IDataReader, _ tableSchema: SchemaDataTable, _ maxRecords: Int32, _ includeSchema: Boolean)

 

Sub WriteDataReader(reader As IDataReader, tableSchema As SchemaDataTable, maxRecords As Int32, includeSchema As Boolean)

Parameters:

  • reader:
  • tableSchema:
  • maxRecords:
  • includeSchema:

WriteDataReaderData    (declared in DataStreamer)

 

method WriteDataReaderData(reader: IDataReader; columnMapping: SchemaColumnMappingCollection; data: DataForAppend; unionSource: Int32): Int32

 

Int32 WriteDataReaderData(IDataReader reader, SchemaColumnMappingCollection columnMapping, DataForAppend data, Int32 unionSource)

 

func WriteDataReaderData(_ reader: IDataReader, _ columnMapping: SchemaColumnMappingCollection, _ data: DataForAppend, _ unionSource: Int32) -> Int32

 

Function WriteDataReaderData(reader As IDataReader, columnMapping As SchemaColumnMappingCollection, data As DataForAppend, unionSource As Int32) As Int32

Parameters:

  • reader:
  • columnMapping:
  • data:
  • unionSource:

WriteDataTable (DataTable, SchemaDataTable)    (declared in DataStreamer)

Writes a DataTable to the stream. This method will throw an exception if a DataTable by the same name already exists on the stream.

 

method WriteDataTable(table: DataTable; tableSchema: SchemaDataTable)

 

void WriteDataTable(DataTable table, SchemaDataTable tableSchema)

 

func WriteDataTable(_ table: DataTable, _ tableSchema: SchemaDataTable)

 

Sub WriteDataTable(table As DataTable, tableSchema As SchemaDataTable)

Parameters:

  • table:
  • tableSchema:

WriteDataTable (DataTable, SchemaDataTable, Int32, Boolean)    (declared in DataStreamer)

 

method WriteDataTable(table: DataTable; tableSchema: SchemaDataTable; maxRecords: Int32; includeSchema: Boolean)

 

void WriteDataTable(DataTable table, SchemaDataTable tableSchema, Int32 maxRecords, Boolean includeSchema)

 

func WriteDataTable(_ table: DataTable, _ tableSchema: SchemaDataTable, _ maxRecords: Int32, _ includeSchema: Boolean)

 

Sub WriteDataTable(table As DataTable, tableSchema As SchemaDataTable, maxRecords As Int32, includeSchema As Boolean)

Parameters:

  • table:
  • tableSchema:
  • maxRecords:
  • includeSchema:

WriteDelta (Delta)    (declared in DataStreamer)

 

method WriteDelta(delta: Delta)

 

void WriteDelta(Delta delta)

 

func WriteDelta(_ delta: Delta)

 

Sub WriteDelta(delta As Delta)

Parameters:

  • delta:

WriteDelta (Delta, Boolean)    (declared in DataStreamer)

 

method WriteDelta(delta: Delta; dynamicSelect: Boolean)

 

void WriteDelta(Delta delta, Boolean dynamicSelect)

 

func WriteDelta(_ delta: Delta, _ dynamicSelect: Boolean)

 

Sub WriteDelta(delta As Delta, dynamicSelect As Boolean)

Parameters:

  • delta:
  • dynamicSelect:

WriteDelta (DataTable, Boolean): Delta    (declared in DataStreamer)

This method will write a delta to the stream. If there already is a delta by this name it will throw an exception.

 

method WriteDelta(table: DataTable; dynamicSelect: Boolean): Delta

 

Delta WriteDelta(DataTable table, Boolean dynamicSelect)

 

func WriteDelta(_ table: DataTable, _ dynamicSelect: Boolean) -> Delta

 

Function WriteDelta(table As DataTable, dynamicSelect As Boolean) As Delta

Parameters:

  • table:
  • dynamicSelect:

 

DataReaderNeedsSchema    (declared in DataStreamer)

 

property DataReaderNeedsSchema: Boolean read;

 

Boolean DataReaderNeedsSchema { get; }

 

var DataReaderNeedsSchema: Boolean { get{} }

 

ReadOnly Property DataReaderNeedsSchema() As Boolean

DefaultStringEncoding

 

property DefaultStringEncoding: Encoding read write;

 

Encoding DefaultStringEncoding { get; set; }

 

var DefaultStringEncoding: Encoding { get{} set{} }

 

Property DefaultStringEncoding() As Encoding

Elements    (declared in DataStreamer)

 

property Elements: Dictionary<String, StreamElementInfo> read;

 

Dictionary<String, StreamElementInfo> Elements { get; }

 

var Elements: Dictionary<String, StreamElementInfo> { get{} }

 

ReadOnly Property Elements() As Dictionary<String, StreamElementInfo>

InitializationMode  protected    (declared in DataStreamer)

 

property InitializationMode: StreamerInitialization read;

 

StreamerInitialization InitializationMode { get; }

 

var InitializationMode: StreamerInitialization { get{} }

 

ReadOnly Property InitializationMode() As StreamerInitialization

SendReducedDelta

Determines if streamer would use Reduced Delta feature or not. If this feature is on, sending data packets will only contain fields that are either part of the Primary Key (needed to locate the record that will be updated), and/or the fields that have actually been changed.

 

property SendReducedDelta: Boolean read write;

 

Boolean SendReducedDelta { get; set; }

 

var SendReducedDelta: Boolean { get{} set{} }

 

Property SendReducedDelta() As Boolean

StreamType

 

property StreamType: StreamType read;

 

StreamType StreamType { get; }

 

var StreamType: StreamType { get{} }

 

ReadOnly Property StreamType() As StreamType

 

GetLoggedDeltaFields  protected    (declared in DataStreamer)

 

class method GetLoggedDeltaFields(delta: Delta; out fields: SchemaField; out mapping: Int32)

 

static void GetLoggedDeltaFields(Delta delta, out SchemaField fields, out Int32 mapping)

 

static func GetLoggedDeltaFields(_ delta: Delta, _ fields: inout SchemaField, _ mapping: inout Int32)

 

Shared Sub GetLoggedDeltaFields(delta As Delta, <OutAttribute> ByRef fields As SchemaField, <OutAttribute> ByRef mapping As Int32)

Parameters:

  • delta:
  • fields:
  • mapping:

ItemExistInArray  protected    (declared in DataStreamer)

 

class method ItemExistInArray(data: array of String; item: String): Boolean

 

static Boolean ItemExistInArray(String[] data, String item)

 

static func ItemExistInArray(_ data: String..., _ item: String) -> Boolean

 

Shared Function ItemExistInArray(data As String(), item As String) As Boolean

Parameters:

  • data:
  • item:

NeedIncludeValuesToStream  protected    (declared in DataStreamer)

 

class method NeedIncludeValuesToStream(oldValue: Object; newValue: Object; isReducedDelta: Boolean; isPrimaryKey: Boolean; out includeOld: Boolean; out includeNew: Boolean)

 

static void NeedIncludeValuesToStream(Object oldValue, Object newValue, Boolean isReducedDelta, Boolean isPrimaryKey, out Boolean includeOld, out Boolean includeNew)

 

static func NeedIncludeValuesToStream(_ oldValue: Object, _ newValue: Object, _ isReducedDelta: Boolean, _ isPrimaryKey: Boolean, _ includeOld: inout Boolean, _ includeNew: inout Boolean)

 

Shared Sub NeedIncludeValuesToStream(oldValue As Object, newValue As Object, isReducedDelta As Boolean, isPrimaryKey As Boolean, <OutAttribute> ByRef includeOld As Boolean, <OutAttribute> ByRef includeNew As Boolean)

Parameters:

  • oldValue:
  • newValue:
  • isReducedDelta:
  • isPrimaryKey:
  • includeOld:
  • includeNew:

 

constructor

 

constructor

 

Bin2DataStreamer()

 

init()

 

Sub New()

constructor (IContainer)

 

constructor(container: IContainer)

 

Bin2DataStreamer(IContainer container)

 

init(_ container: IContainer)

 

Sub New(container As IContainer)

Parameters:

  • container:

constructor (Stream, StreamerInitialization)

 

constructor(dataStream: Stream; mode: StreamerInitialization)

 

Bin2DataStreamer(Stream dataStream, StreamerInitialization mode)

 

init(_ dataStream: Stream, _ mode: StreamerInitialization)

 

Sub New(dataStream As Stream, mode As StreamerInitialization)

Parameters:

  • dataStream:
  • mode:

BeginWriteDataReader    (declared in DataStreamer)

 

method BeginWriteDataReader(tableSchema: SchemaDataTable; fields: array of String; maxRecords: Int32; includeSchema: Boolean): DataForAppend

 

DataForAppend BeginWriteDataReader(SchemaDataTable tableSchema, String[] fields, Int32 maxRecords, Boolean includeSchema)

 

func BeginWriteDataReader(_ tableSchema: SchemaDataTable, _ fields: String..., _ maxRecords: Int32, _ includeSchema: Boolean) -> DataForAppend

 

Function BeginWriteDataReader(tableSchema As SchemaDataTable, fields As String(), maxRecords As Int32, includeSchema As Boolean) As DataForAppend

Parameters:

  • tableSchema:
  • fields:
  • maxRecords:
  • includeSchema:

CountElements    (declared in DataStreamer)

 

method CountElements(elementType: StreamElementType): Int32

 

Int32 CountElements(StreamElementType elementType)

 

func CountElements(_ elementType: StreamElementType) -> Int32

 

Function CountElements(elementType As StreamElementType) As Int32

Parameters:

  • elementType:

Dispose  protected    (declared in DataStreamer)

 

method Dispose(disposing: Boolean)

 

void Dispose(Boolean disposing)

 

func Dispose(_ disposing: Boolean)

 

Sub Dispose(disposing As Boolean)

Parameters:

  • disposing:

EndWriteDataReader    (declared in DataStreamer)

 

method EndWriteDataReader(data: DataForAppend): Int32

 

Int32 EndWriteDataReader(DataForAppend data)

 

func EndWriteDataReader(_ data: DataForAppend) -> Int32

 

Function EndWriteDataReader(data As DataForAppend) As Int32

Parameters:

  • data:

FinalizeStreamer    (declared in DataStreamer)

Finalize the read/writing of data. This method should be called after all elements are written or when reading is complete.

 

method FinalizeStreamer

 

void FinalizeStreamer()

 

func FinalizeStreamer()

 

Sub FinalizeStreamer()

GetDataReader    (declared in DataStreamer)

 

method GetDataReader(tableName: String): IDataReader

 

IDataReader GetDataReader(String tableName)

 

func GetDataReader(_ tableName: String) -> IDataReader

 

Function GetDataReader(tableName As String) As IDataReader

Parameters:

  • tableName:

InitializeStreamer    (declared in DataStreamer)

 

method InitializeStreamer(dataStream: Stream; mode: StreamerInitialization)

 

void InitializeStreamer(Stream dataStream, StreamerInitialization mode)

 

func InitializeStreamer(_ dataStream: Stream, _ mode: StreamerInitialization)

 

Sub InitializeStreamer(dataStream As Stream, mode As StreamerInitialization)

Parameters:

  • dataStream:
  • mode:

ListElements    (declared in DataStreamer)

Returns all elements in the stream that have their ElementType matching the given parameter.

 

method ListElements(elementType: StreamElementType): List<StreamElementInfo>

 

List<StreamElementInfo> ListElements(StreamElementType elementType)

 

func ListElements(_ elementType: StreamElementType) -> List<StreamElementInfo>

 

Function ListElements(elementType As StreamElementType) As List<StreamElementInfo>

Parameters:

  • elementType:

ReadDataTable (Stream, String, DataTable)    (declared in DataStreamer)

 

method ReadDataTable(dataStream: Stream; tableName: String; destination: DataTable)

 

void ReadDataTable(Stream dataStream, String tableName, DataTable destination)

 

func ReadDataTable(_ dataStream: Stream, _ tableName: String, _ destination: DataTable)

 

Sub ReadDataTable(dataStream As Stream, tableName As String, destination As DataTable)

Parameters:

  • dataStream:
  • tableName:
  • destination:

ReadDataTable (Stream, String, DataTable, Boolean)    (declared in DataStreamer)

 

method ReadDataTable(dataStream: Stream; tableName: String; destination: DataTable; applySchema: Boolean)

 

void ReadDataTable(Stream dataStream, String tableName, DataTable destination, Boolean applySchema)

 

func ReadDataTable(_ dataStream: Stream, _ tableName: String, _ destination: DataTable, _ applySchema: Boolean)

 

Sub ReadDataTable(dataStream As Stream, tableName As String, destination As DataTable, applySchema As Boolean)

Parameters:

  • dataStream:
  • tableName:
  • destination:
  • applySchema:

ReadDataTable (Stream, String, DataTable, Boolean, Boolean)    (declared in DataStreamer)

 

method ReadDataTable(dataStream: Stream; tableName: String; destination: DataTable; applySchema: Boolean; loadRecords: Boolean)

 

void ReadDataTable(Stream dataStream, String tableName, DataTable destination, Boolean applySchema, Boolean loadRecords)

 

func ReadDataTable(_ dataStream: Stream, _ tableName: String, _ destination: DataTable, _ applySchema: Boolean, _ loadRecords: Boolean)

 

Sub ReadDataTable(dataStream As Stream, tableName As String, destination As DataTable, applySchema As Boolean, loadRecords As Boolean)

Parameters:

  • dataStream:
  • tableName:
  • destination:
  • applySchema:
  • loadRecords:

ReadDataTable (String, DataTable, Boolean, Boolean)    (declared in DataStreamer)

 

method ReadDataTable(tableName: String; destination: DataTable; applySchema: Boolean; loadData: Boolean)

 

void ReadDataTable(String tableName, DataTable destination, Boolean applySchema, Boolean loadData)

 

func ReadDataTable(_ tableName: String, _ destination: DataTable, _ applySchema: Boolean, _ loadData: Boolean)

 

Sub ReadDataTable(tableName As String, destination As DataTable, applySchema As Boolean, loadData As Boolean)

Parameters:

  • tableName:
  • destination:
  • applySchema:
  • loadData:

ReadDataTableSchema    (declared in DataStreamer)

Reads the schema of a DataTable and returns it.

 

method ReadDataTableSchema(tableName: String): SchemaDataTable

 

SchemaDataTable ReadDataTableSchema(String tableName)

 

func ReadDataTableSchema(_ tableName: String) -> SchemaDataTable

 

Function ReadDataTableSchema(tableName As String) As SchemaDataTable

Parameters:

  • tableName:

ReadDelta (Delta)    (declared in DataStreamer)

This method will return a delta from the stream. If there is no delta by the name passed it will throw an exception.

 

method ReadDelta(destination: Delta)

 

void ReadDelta(Delta destination)

 

func ReadDelta(_ destination: Delta)

 

Sub ReadDelta(destination As Delta)

Parameters:

  • destination:

ReadDelta (Schema, String): Delta    (declared in DataStreamer)

 

method ReadDelta(schema: Schema; tableName: String): Delta

 

Delta ReadDelta(Schema schema, String tableName)

 

func ReadDelta(_ schema: Schema, _ tableName: String) -> Delta

 

Function ReadDelta(schema As Schema, tableName As String) As Delta

Parameters:

  • schema:
  • tableName:

WriteDataReader (IDataReader, SchemaDataTable)    (declared in DataStreamer)

Writes the contents of a DataReader and the associated schema to the stream.

 

method WriteDataReader(reader: IDataReader; tableSchema: SchemaDataTable)

 

void WriteDataReader(IDataReader reader, SchemaDataTable tableSchema)

 

func WriteDataReader(_ reader: IDataReader, _ tableSchema: SchemaDataTable)

 

Sub WriteDataReader(reader As IDataReader, tableSchema As SchemaDataTable)

Parameters:

  • reader:
  • tableSchema:

WriteDataReader (IDataReader, SchemaDataTable, array of String, Int32, Boolean, SchemaColumnMappingCollection)    (declared in DataStreamer)

 

method WriteDataReader(reader: IDataReader; tableSchema: SchemaDataTable; fields: array of String; maxRecords: Int32; includeSchema: Boolean; columnMapping: SchemaColumnMappingCollection)

 

void WriteDataReader(IDataReader reader, SchemaDataTable tableSchema, String[] fields, Int32 maxRecords, Boolean includeSchema, SchemaColumnMappingCollection columnMapping)

 

func WriteDataReader(_ reader: IDataReader, _ tableSchema: SchemaDataTable, _ fields: String..., _ maxRecords: Int32, _ includeSchema: Boolean, _ columnMapping: SchemaColumnMappingCollection)

 

Sub WriteDataReader(reader As IDataReader, tableSchema As SchemaDataTable, fields As String(), maxRecords As Int32, includeSchema As Boolean, columnMapping As SchemaColumnMappingCollection)

Parameters:

  • reader:
  • tableSchema:
  • fields:
  • maxRecords:
  • includeSchema:
  • columnMapping:

WriteDataReader (IDataReader, SchemaDataTable, Int32)    (declared in DataStreamer)

 

method WriteDataReader(reader: IDataReader; tableSchema: SchemaDataTable; maxRecords: Int32)

 

void WriteDataReader(IDataReader reader, SchemaDataTable tableSchema, Int32 maxRecords)

 

func WriteDataReader(_ reader: IDataReader, _ tableSchema: SchemaDataTable, _ maxRecords: Int32)

 

Sub WriteDataReader(reader As IDataReader, tableSchema As SchemaDataTable, maxRecords As Int32)

Parameters:

  • reader:
  • tableSchema:
  • maxRecords:

WriteDataReader (IDataReader, SchemaDataTable, Int32, Boolean)    (declared in DataStreamer)

 

method WriteDataReader(reader: IDataReader; tableSchema: SchemaDataTable; maxRecords: Int32; includeSchema: Boolean)

 

void WriteDataReader(IDataReader reader, SchemaDataTable tableSchema, Int32 maxRecords, Boolean includeSchema)

 

func WriteDataReader(_ reader: IDataReader, _ tableSchema: SchemaDataTable, _ maxRecords: Int32, _ includeSchema: Boolean)

 

Sub WriteDataReader(reader As IDataReader, tableSchema As SchemaDataTable, maxRecords As Int32, includeSchema As Boolean)

Parameters:

  • reader:
  • tableSchema:
  • maxRecords:
  • includeSchema:

WriteDataReaderData    (declared in DataStreamer)

 

method WriteDataReaderData(reader: IDataReader; columnMapping: SchemaColumnMappingCollection; data: DataForAppend; unionSource: Int32): Int32

 

Int32 WriteDataReaderData(IDataReader reader, SchemaColumnMappingCollection columnMapping, DataForAppend data, Int32 unionSource)

 

func WriteDataReaderData(_ reader: IDataReader, _ columnMapping: SchemaColumnMappingCollection, _ data: DataForAppend, _ unionSource: Int32) -> Int32

 

Function WriteDataReaderData(reader As IDataReader, columnMapping As SchemaColumnMappingCollection, data As DataForAppend, unionSource As Int32) As Int32

Parameters:

  • reader:
  • columnMapping:
  • data:
  • unionSource:

WriteDataTable (DataTable, SchemaDataTable)    (declared in DataStreamer)

Writes a DataTable to the stream. This method will throw an exception if a DataTable by the same name already exists on the stream.

 

method WriteDataTable(table: DataTable; tableSchema: SchemaDataTable)

 

void WriteDataTable(DataTable table, SchemaDataTable tableSchema)

 

func WriteDataTable(_ table: DataTable, _ tableSchema: SchemaDataTable)

 

Sub WriteDataTable(table As DataTable, tableSchema As SchemaDataTable)

Parameters:

  • table:
  • tableSchema:

WriteDataTable (DataTable, SchemaDataTable, Int32, Boolean)    (declared in DataStreamer)

 

method WriteDataTable(table: DataTable; tableSchema: SchemaDataTable; maxRecords: Int32; includeSchema: Boolean)

 

void WriteDataTable(DataTable table, SchemaDataTable tableSchema, Int32 maxRecords, Boolean includeSchema)

 

func WriteDataTable(_ table: DataTable, _ tableSchema: SchemaDataTable, _ maxRecords: Int32, _ includeSchema: Boolean)

 

Sub WriteDataTable(table As DataTable, tableSchema As SchemaDataTable, maxRecords As Int32, includeSchema As Boolean)

Parameters:

  • table:
  • tableSchema:
  • maxRecords:
  • includeSchema:

WriteDelta (Delta)    (declared in DataStreamer)

 

method WriteDelta(delta: Delta)

 

void WriteDelta(Delta delta)

 

func WriteDelta(_ delta: Delta)

 

Sub WriteDelta(delta As Delta)

Parameters:

  • delta:

WriteDelta (Delta, Boolean)    (declared in DataStreamer)

 

method WriteDelta(delta: Delta; dynamicSelect: Boolean)

 

void WriteDelta(Delta delta, Boolean dynamicSelect)

 

func WriteDelta(_ delta: Delta, _ dynamicSelect: Boolean)

 

Sub WriteDelta(delta As Delta, dynamicSelect As Boolean)

Parameters:

  • delta:
  • dynamicSelect:

WriteDelta (DataTable, Boolean): Delta    (declared in DataStreamer)

This method will write a delta to the stream. If there already is a delta by this name it will throw an exception.

 

method WriteDelta(table: DataTable; dynamicSelect: Boolean): Delta

 

Delta WriteDelta(DataTable table, Boolean dynamicSelect)

 

func WriteDelta(_ table: DataTable, _ dynamicSelect: Boolean) -> Delta

 

Function WriteDelta(table As DataTable, dynamicSelect As Boolean) As Delta

Parameters:

  • table:
  • dynamicSelect: