TDP.NET API
This chapter describes API provided by TDP.NET.
Basic Classes
The following describes basic TDP.NET classes.
TiberoClientFactory
Methods
Method
Description
CreateCommand
Returns a DbCommand object that represents a TiberoCommand object.
CreateCommandBuilder
Returns a DbCommandBuilder object that represents a
TiberoCommandBuilder object.
CreateConnection
Returns a DbConnection object that represents a TiberoConnection object.
CreateConnectionString
Builder
Returns a DbConnectionStringBuilder object that represents a
TiberoConnectionStringBuilder object.
CreateDataAdapter
Returns a DbDataAdapter object that represents a TiberoDataAdapter object.
CreateParameter
Returns a DbParameter object that represents a TiberoParameter object.
TiberoCommand
Properties
Property
Description
ArrayBindCount
Specifies the number of array elements to bind.
BindByName
Specifies a binding method in the collection.
CommandText
Specifies an SQL statement or a stored procedure to run.
CommandTimeout
Specifies the maximum time for executing a command in seconds.
CommandType
Specifies how to interpret CommandText.
Connection
Specifies a TiberoConnection object.
Parameters
Specifies parameters for an SQL statement or a stored procedure.
Transaction
Specifies a TiberoTransaction object.
Methods
Method
Description
Cancel
Cancels a command that is currently executing.
CreateParameter
Creates a new instance of the TiberoParameter class.
ExecuteNonQuery
Executes an SQL statement.
ExecuteReader
Executes a command and returns a TiberoDataReader object.
ExecuteScalar
Executes a command and returns the first result.
TiberoCommandBuilder
Property
Property
Description
DataAdapter
Indicates TiberoDataAdapter for which SQL statements are generated.
Methods
Method
Description
GetDeleteCommand
Gets an automatically generated TiberoCommand object that has an SQL statement of performing deletions.
GetInsertCommand
Gets an automatically generated TiberoCommand object that has an SQL statement of performing insertions.
GetUpdateCommand
Gets an automatically generated TiberoCommand object that has an SQL statement of performing updates.
TiberoConnection
Properties
Property
Description
ClientId
Specifies the client identifier for a connection.
ConnectionString
Specifies connection information used for a connection.
ConnectionTimeout
Indicates the maximum time for the Open method to get a pooled connection
before the request is ended.
DataSource
Specifies a data source name.
ServerVersion
Specifies Tibero server version.
DatabaseName
Specifies a database name.
HostName
Specifies a client host name.
InstanceName
Specifies an instance name.
ServiceName
Specifies a service name.
State
Specifies the current state of a connection.
Methods
Method
Description
BeginTransaction
Begins a local transaction.
Close
Closes a database connection.
CreateCommand
Creates and returns a TiberoCommand object associated with a
TiberoConnection object.
Open
Opens a database connection with the setting specified by ConnectionString.
TiberoConnectionStringBuilder
Properties
Property
Description
ConnectionTimeout
Specifies the value corresponding to Connection Timeout in ConnectionString.
DataSource
Specifies the value corresponding to Data Source in ConnectionString.
DecrPoolSize
Specifies the value corresponding to Decr Pool Size in ConnectionString.
Enlist
Specifies the value corresponding to Enlist in ConnectionString.
IncrPoolSize
Specifies the value corresponding to Incr Pool Size in ConnectionString.
MaxPoolSize
Specifies the value corresponding to Max Pool Size in ConnectionString.
MinPoolSize
Specifies the value corresponding to Min Pool Size in ConnectionString.
Password
Specifies the value corresponding to Password in ConnectionString.
Pooling
Specifies the value corresponding to Pooling in ConnectionString.
UserId
Specifies the value corresponding to User Id in ConnectionString.
ValidateConnection
Specifies the value corresponding to Validate Connection in ConnectionString.
TiberoDataAdapter
Properties
Property
Description
DeleteCommand
An SQL statement or a stored procedure for deletions.
InsertCommand
An SQL statement or a stored procedure for insertions.
SelectCommand
An SQL statement or a stored procedure for selections.
UpdateCommand
An SQL statement or a stored procedure for updates.
Methods
Method
Description
Fill
Adds or refreshes rows in DataSet to match the data in a database.
Update
Performs updates.
TiberoDataReader
Properties
Property
Description
FieldCount
Gets the number of columns in a result set.
HasRows
Indicates whether TiberoDataReader has one or more rows.
HiddenFieldCount
Gets the number of hidden fields in TiberoDataReader.
RecordsAffected
Gets the number of rows modified, inserted, or deleted by execution of an SQL statement.
VisibleFieldCount
Gets the number of non-hidden fields in TiberoDataReader.
Methods
Method
Description
Close
Closes TiberoDataReader.
GetBytes
Populates a provided byte array with up to the maximum number of bytes, from a specified column.
GetDataTypeName
Returns the type name of a specified column.
GetDateTime
Returns the DateTime value of a specified column.
GetDecimal
Returns the decimal value of a specified column.
GetDouble
Returns the double value of a specified column.
GetFieldType
Returns the type of a specified column.
GetFloat
Returns the float value of a specified column.
GetInt16
Returns the Int16 value of a specified column.
GetInt32
Returns the Int32 value of a specified column.
GetInt64
Returns the Int64 value of a specified column.
GetName
Returns the name of a specified column.
GetOrdinal
Returns the 0-based ordinal of a specified column name.
GetString
Returns the string value of a specified column.
GetTiberoBinary
Returns TiberoBinary of a specified column.
GetTiberoBlob
Returns TiberoBlob of a specified column.
GetTiberoClob
Returns TiberoClob of a specified column.
GetTiberoDate
Returns TiberoDate of a specified column.
GetTiberoDecimal
Returns TiberoDecimal of a specified column.
GetTiberoIntervalDS
Returns TiberoIntervalDS of a specified column.
GetTiberoIntervalYM
Returns TiberoIntervalYM of a specified column.
GetTiberoString
Returns TiberoString of a specified column.
GetTiberoTimestamp
Returns TiberoTimestamp of a specified column.
GetTimeSpan
Returns the TimeSpan value of a specified column.
GetValue
Returns a column value as a .NET type.
GetValues
Returns all column values as .NET types.
IsDBNull
Indicates whether a column value is NULL.
NextResult
Reads the next result set.
Read
Reads the next row in a result set.
TiberoException
Method
Method
Description
ToString
Returns an exception string.
TiberoParameter
Properties
Property
Description
ArrayBindSize
Specifies the input or output size of elements in the Value property of a parameter before or after array binding.
ArrayBindStatus
Specifies the input or output status of elements in the Value property of a parameter before or after array binding.
CollectionType
Specifies a collection type of TiberoParameter.
DbType
Specifies a data type of a parameter by using the Data.DbType enumeration type.
Direction
Specifies whether a parameter is input-only, output-only, or bi-directional.
ParameterName
Specifies a parameter name.
Precision
Specifies the maximum number of digits used to represent the Value property.
Scale
Specifies the number of decimal places used to represent the Value property.
SourceColumn
Specifies the name of a DataTable column of DataSet.
TiberoDbType
Specifies a Tibero data type.
Value
Specifies the value of Parameter.
TiberoParameterCollection
Properties
Property
Description
Count
Specifies the number of TiberoParameter objects.
Item
Gets and sets a TiberoParameter object.
Methods
Method
Description
Add
Adds objects.
AddRange
Adds elements to the end of TiberoParameterCollection.
Clear
Removes all TiberoParameter objects.
Contains
Indicates whether objects exist.
CopyTo
Copies TiberoParameter objects, starting with a provided index to a provided array.
IndexOf
Returns object indexes.
Insert
Inserts provided TiberoParameter to a specified index.
Remove
Removes objects from Collection.
RemoveAt
Removes objects by using a specified index or name.
TiberoTransaction
Properties
Property
Description
IsolationLevel
Specifies an isolation level for a transaction.
Connection
Specifies a connection that is associated with a transaction.
Methods
Method
Description
Commit
Commits a transaction.
Rollback
Rolls back a transaction.
Type Classes
The following describes TDP.NET type classes.
TiberoBlob
Properties
Property
Description
CanRead
Indicates whether a LOB stream can be read.
CanSeek
Indicates whether forward and backward seek operations are performed.
CanWrite
Indicates whether a LOB object supports writing.
Connection
Indicates TiberoConnection that is used to retrieve and write BLOB data.
IsEmpty
Indicates whether BLOB is empty.
IsNull
Indicates whether a current instance has a null value.
IsTemporary
Indicates whether a current instance is temporary BLOB.
Length
Indicates the size of BLOB data.
Position
Indicates the current read or write position in a LOB stream.
Value
Returns data as a byte array.
Methods
Method
Description
Append
Appends provided data to a current TiberoBlob instance.
Clone
Creates a copy of a TibeoBlob object.
Close
Closes a current stream and releases associated resources.
Compare
Compares data referenced by a current instance and data of a provided object.
CopyTo
Copies data to a TiberoBlob object.
Dispose
Releases resources allocated by an object.
Erase
Erases data.
IsEqual
Compares two TiberoBlobs data.
Read
Reads a specified amount of bytes and populates a buffer.
Search
Searches for a binary pattern.
Seek
Sets a position in a current LOB stream.
SetLength
Trims or truncates a BLOB value to a specified length.
Write
Writes a provided buffer to TiberoBlob.
TiberoClob
Properties
Property
Description
CanRead
Indicates whether a LOB stream can be read.
CanSeek
Indicates whether forward and backward seek operations are performed.
CanWrite
Indicates whether a LOB object supports writing.
Connection
Indicates TiberoConnection that is used to retrieve and write CLOB data.
IsEmpty
Indicates whether CLOB is empty.
IsNClob
Indicates whether a TiberoClob object is NCLOB.
IsNull
Indicates whether a current instance has a null value.
IsTemporary
Indicates whether a current instance is temporary CLOB.
Length
Indicates the size of CLOB data.
Position
Indicates the current read or write position in a LOB stream.
Value
Returns data as a string.
Methods
Method
Description
Append
Appends provided data to a current TiberoClob instance.
Clone
Creates a copy of a TibeoClob object.
Close
Closes a current stream and releases associated resources.
Compare
Compares current instance data and a provided object.
CopyTo
Copies data to a TiberoClob object.
Dispose
Releases resources allocated by an object.
Erase
Erases data.
IsEqual
Compares two TiberoClobs data.
Read
Reads from a current instance.
Search
Searches for a character pattern.
Seek
Sets a position in a current LOB stream.
SetLength
Trims or truncates a CLOB value to a specified length.
Write
Writes a provided buffer to TiberoClob.
TiberoRefCursor
Property
Property
Description
Connection
Reference to TiberoConnection used to fetch REF CURSOR data.
Method
Method
Description
GetDataReader
Returns a TiberoDataReader object for REF CURSOR.
TiberoBinary
Properties
Property
Description
IsNull
Indicates whether a current instance has a null value.
Length
Indicates the length of binary data.
Value
Returns binary data.
Static methods
Method
Description
Equals
Determines if two TiberoBinary values are equal.
GreaterThan
Determines if the first TiberoBinary value is greater than the second value.
GreaterThanOrEqual
Determines if the first TiberoBinary value is greater than or equal to the second value.
LessThan
Determines if the first TiberoBinary value is less than the second value.
LessThanOrEqual
Determines if the first TiberoBinary value is less than or equal to the second value.
NotEquals
Determines if two TiberoBinary values are not equal.
Method
Method
Description
Equals
Determines if two objects have the same binary data.
TiberoBoolean
Property
Property
Description
Value
Returns a boolean value represented by a current instance.
Static methods
Method
Description
And
Returns the result of bitwise AND operation of two TiberoBoolean instances.
Equals
Determines if two TiberoBoolean values are equal.
GreaterThan
Determines if the first TiberoBoolean value is greater than the second value.
GreaterThanOrEquals
Determines if the first TiberoBoolean value is greater than or equal to the second value.
LessThan
Determines if the first TiberoBoolean value is less than the second value.
LessThanOrEquals
Determines if the first TiberoBoolean value is less than or equal to the second value.
NotEquals
Determines if two TiberoBoolean values are not equal.
OnesComplement
Returns the result of a one's complement operation on a specified TiberoBoolean value.
Or
Returns the result of bitwise OR operation of two TiberoBoolean instances.
Parse
Returns TiberoBoolean that its value is set using a string.
Xor
Returns the result of bitwise XOR operation of two TiberoBoolean instances.
Methods
Method
Description
CompareTo
Compares a current instance to a provided object and returns an integer that represents their relative values.
Equals
Determines whether an object is an instance of TiberoBoolean and whether the value of the object is equal to a current instance.
GetHashCode
Returns a hash code for a current instance.
ToString
Returns a string that represents a current instance.
TiberoDate
Properties
Property
Description
Day
Gets the day value of TibeoDate.
Hour
Gets the hour value of TibeoDate.
Minute
Gets the minute value of TibeoDate.
Month
Gets the month value of TibeoDate.
Second
Gets the second value of TibeoDate.
Value
Gets the date and time of TibeoDate.
Year
Gets the year value of TibeoDate.
Static methods
Method
Description
Equals
Determines if two TiberoDate values are equal.
GreaterThan
Determines if the first TiberoDate value is greater than the second value.
GreaterThanOrEqual
Determines if the first TiberoDate value is greater than or equal to the second value.
LessThan
Determines if the first TiberoDate value is less than the second value.
LessThanOrEqual
Determines if the first TiberoDate value is less than or equal to the second value.
NotEquals
Determines if two TiberoDate values are not equal.
Parse
Returns TiberoDate that its value is set using a string.
Methods
Method
Description
CompareTo
Compares a current instance to a provided object and returns an integer that represents their relative values.
Equals
Determines whether an object is an instance of TiberoDate and whether the value of the object is equal to a current instance.
ToString
Returns a string that represents a current instance.
TiberoDecimal
Property
Property
Description
Value
Returns a decimal value.
Static methods
Method
Description
Equals
Determines if two TiberoDecimal values are equal.
GreaterThan
Determines if the first TiberoDecimal value is greater than the second value.
GreaterThanOrEqual
Determines if the first TiberoDecimal value is greater than or equal to the second value.
LessThan
Determines if the first TiberoDecimal value is less than the second value.
LessThanOrEqual
Determines if the first TiberoDecimal value is less than or equal to the second value.
NotEquals
Determines if two TiberoDecimal values are not equal.
Abs
Returns the absolute value of TiberoDecimal.
Add
Adds two TiberoDecimals.
Ceiling
Returns the result value of the ceiling function as TiberoDecimal.
Divide
Divides one TiberoDecimal by another and returns the result value.
Floor
Returns the result value of the floor function as TiberoDecimal.
Max
Returns the maximum value of two TiberoDecimals.
Min
Returns the minimum value of two TiberoDecimals.
Mod
Returns the result value of the Modulo operation on two TiberoDecimal values.
Multiply
Returns the result value of multiplying two TiberoDecimals.
Negate
Returns the negation value of provided TiberoDecimal.
Parse
Converts a string to TiberoDecimal.
Round
Returns the result value of rounding off TiberoDecimal to a specified place.
Sign
Determines the sign of TiberoDecimal.
Sqrt
Returns the square root of provided TiberoDecimal.
Subtract
Returns the result value of subtracting TiberoDecimal from another.
Exp
Returns a value set to e raised to a provided power.
Log
Returns a provided value set to the logarithm of a provided TiberoDecimal.
Pow
Returns a value set to a provided TiberoDecimal raised to a supplied power.
Acos
Returns an angle in radians whose cosine is provided TiberoDecimal.
Asin
Returns an angle in radians whose sine is provided TiberoDecimal.
Atan
Returns an angle in radians whose tangent is provided TiberoDecimal.
Atan2
Returns an angle in radians whose tangent is the quotient of two provided TiberoDecimals.
Cos
Returns the cosine of a provided angle in radians.
Sin
Returns the sine of a provided angle in radians.
Tan
Returns the tangent of a provided angle in radians.
Cosh
Returns the hyperbolic cosine of a provided angle in radians.
Sinh
Returns the hyperbolic sine of a provided angle in radians.
Tanh
Returns the hyperbolic tangent of a provided angle in radians.
Methods
Method
Description
Equals
Determines whether an object is an instance of TiberoDecimal and whether the value of the object is equal to a current instance.
ToByte
Returns the byte representation of a current instance.
ToDouble
Returns the double representation of a current instance.
ToInt16
Returns the Int16 representation of a current instance.
ToInt32
Returns the Int32 representation of a current instance.
ToInt64
Returns the Int64 representation of a current instance.
ToSingle
Returns the Single representation of a current instance.
ToString
Returns the String representation of a current instance.
TiberoIntervalDS
Properties
Property
Description
Days
Gets the days value of TiberoIntervalDS.
Hours
Gets the hours value of TiberoIntervalDS.
Milliseconds
Gets the milliseconds value of TiberoIntervalDS.
Minutes
Gets the minutes value of TiberoIntervalDS.
Nanoseconds
Gets the nanoseconds value of TiberoIntervalDS.
Seconds
Gets the seconds value of TiberoIntervalDS.
Value
Specifies the time interval that is stored in TiberoIntervalDS.
TiberoIntervalYM
Properties
Property
Description
Months
Gets the months value of TiberoIntervalYM.
Value
Specifies the total number of months that is stored in TiberoIntervalYM.
Years
Gets the years value of TiberoIntervalYM.
TiberoString
Properties
Property
Description
IsCaseIgnored
Indicates whether case should be ignored when performing string comparison.
IsNull
Indicates whether a current instance has a null value.
Item
Gets a particular character in TiberoString by using an index.
Length
Returns the length of TiberoString.
Value
Returns string data of TiberoString.
Static methods
Method
Description
Concat
Concatenates two TiberoStrings and returns a new TiberoString.
Equals
Determines if two TiberoString values are equal.
GreaterThan
Determines if the first TiberoString value is greater than the second value.
GreaterThanOrEqual
Determines if the first TiberoString value is greater than or equal to the second value.
LessThan
Determines if the first TiberoString value is less than the second value.
LessThanOrEqual
Determines if the first TiberoString value is less than or equal to the second value.
NotEquals
Determines if two TiberoString values are not equal.
Methods
Method
Description
Clone
Creates a copy of a TiberoString object.
CompareTo
Compares a current instance to a provided object and returns an integer that represents their relative values.
Equals
Determines whether an object value has the same string value as a current instance.
GetUnicodeBytes
Returns a TiberoString value as a byte array in Unicode format.
ToString
Returns a string that represents a current instance.
TiberoTimeStamp
Properties
Property
Description
Day
Gets the day value of TiberoTimeStamp.
Hour
Gets the hour value of TiberoTimeStamp.
Millisecond
Gets the millisecond value of TiberoTimeStamp.
Minute
Gets the minute value of TiberoTimeStamp.
Month
Gets the month value of TiberoTimeStamp.
Nanosecond
Gets the nanosecond value of TiberoTimeStamp.
Second
Gets the second value of TiberoTimeStamp.
Value
Gets the date and time of TiberoTimestamp.
Year
Gets the year value of TiberoTimeStamp.
UDT
The following describes TDP.NET UDT classes.
TiberoCustomTypeMappingAttribute
Property
Property
Description
UdtTypeName
Specifies a Tibero user-defined type name that a custom class maps to.
TiberoObjectMappingAttribute
Properties
Property
Description
AttributeIndex
Specifies the index of a Tibero object property to retrieve.
AttributeName
Specifies the name of a Tibero object property to retrieve.
ITiberoCustomType
Methods
Method
Description
FromCustomObject
Creates a Tibero object or collection by using a specified Tibero UDT.
ToCustomObject
Creates a custom object by using a specified Tibero UDT.
ITiberoCustomTypeFactory
Method
Method
Description
CreateObject
Returns a new custom object that represents a Tibero object or collection.
ITiberoArrayTypeFactory
Method
Method
Description
CreateArray
Returns a new array with a specified length to store Tibero collection
elements.
TiberoUdt
Static methods
Method
Description
GetValue
Gets properties or elements from a specified Tibero UDT.
SetValue
Sets properties or elements on a specified Tibero UDT.
Bulk Copy
The following describes TDP.NET Bulk Copy classes.
TiberoBulkCopy
Properties
Property
Description
BatchSize
Specifies the number of rows to send to a database as a batch.
BulkCopyTimeout
Bulk copy operation timeout. (Unit: seconds)
ColumnMappings
Specifies column mappings between a data source and destination table.
Connection
Specifies a TiberoConnection object used for bulk copy.
DestinationPartitionName
Specifies a destination partition name.
DestinationTableName
Specifies a destination table name.
NotifyAfter
Defines the number of rows to process before a notification event is generated.
Methods
Method
Description
Close
Closes a TiberoBulkCopy instance.
Dispose
Releases allocated resources and memory.
WriteToServer
Copies rows of a provided DataTable to a destination table.
TiberoBulkCopyColumnMapping
Properties
Property
Description
DestinationColumn
Specifies the column name of a destination table to map.
DestinationOrdinal
Specifies the column ordinal value of a destination table to map.
SourceColumn
Specifies the column name of a data source that is being mapped.
SourceOrdinal
Specifies the column ordinal value of a data source that is being mapped.
TiberoBulkCopyColumnMappingCollection
Property
Property
Description
Item[index]
Gets or sets the object at the specified index.
Methods
Method
Description
Add
Adds objects to a collection.
Clear
Clears the contents of a collection.
Contains
Returns a value indicating whether a specified
TiberoBulkCopyColumnMapping object exists in a collection.
CopyTo
Copies elements to an array of TiberoBulkCopyColumnMapping, starting at
a specified index.
IndexOf
Returns the index of a specified TiberoBulkCopyColumnMapping object.
Insert
Inserts a new TiberoBulkCopyColumnMapping object at a specified index.
Remove
Removes a specified TiberoBulkCopyColumnMapping from a collection.
RemoveAt
Removes TiberoBulkCopyColumnMapping from a collection at a specified
index.
TiberoRowsCopiedEventArgs
Properties
Property
Description
Abort
Retrieves or sets a value that indicates whether a bulk copy operation is
aborted.
RowsCopied
Retrieves a value that represents the number of rows copied during a current
bulk copy operation.
Last updated