Chapter 7. Data Access Interfaces
Abstract
This chapter covers installation, configuration, and utilization of the data access drivers / providers (ODBC, JDBC, OLE-DB, and ADO.NET ) that comprise the Virtuoso Client Connectivity kit.
Table of Contents
- 7.1. ADO.Net Data Provider
-
- 7.1.1. Introduction
- 7.1.2. Installation & Configuration
- 7.1.3. Programmers Guide
- 7.2. Interactive SQL Utility
-
- 7.2.1. Invoking ISQL
- 7.2.2. ISQL Commands
- 7.2.3. ISQL Macro Substitution
- 7.2.4. ISQL Variables
- 7.2.5. Using isql as a General Purpose Test Driver
- 7.3. Virtuoso Driver for ODBC
-
- 7.3.1. Windows ODBC Driver Configuration
- 7.3.2. Using X509 Certificates With ODBC Connection
- 7.3.3. Manually configuring a Virtuoso ODBC DSN on Unix
- 7.3.4. ODBC Compliance
- 7.3.5. Virtuoso Scrollable Cursor Engine
- 7.3.6. Effect of Connection & Statement Options
- 7.3.7. Efficient Use of API
- 7.3.8. Executing SQL from Python script
- 7.3.9. Extensions
- 7.3.10. Examples
- 7.4. Virtuoso Driver for JDBC
-
- 7.4.1. Virtuoso Drivers for JDBC Packaging
- 7.4.2. Virtuoso Driver For JDBC URL Format
- 7.4.3. Virtuoso Driver JDBC 3.0 features
- 7.4.4. Virtuoso Driver JDBC 4.0 features
- 7.4.5. Installation & Configuration Steps
- 7.4.6. Virtuoso JDBC Driver Hibernate Support
- 7.4.7. Examples
- 7.5. OLE DB Provider for Virtuoso
-
- 7.5.1. Using the OLE DB Provider for Virtuoso
- 7.5.2. Known Limitations
- 7.5.3. Data Types
- 7.5.4. Metadata
- 7.5.5. Supported Interfaces
- 7.5.6. Data Source Objects
- 7.5.7. Sessions
- 7.5.8. Rowsets
- 7.6. Virtuoso In-Process Client
- 7.7. Unix Domain Socket Connections
- 7.8. Virtuoso Data Access Clients Connection Fail over and Load Balancing Support
7.1. ADO.Net Data Provider
7.1.1. Introduction
Virtuoso includes an ADO.NET 2.x & 3.x data providers compatible with Visual Studio 2008 and Entity Frameworks, that provides access to native Virtuoso data (SQL, XML, and RDF) in addition to any Virtuoso Linked Tables from external ODBC and JDBC accessible data sources. Known-compatible external data sources include Oracle (versions 7.x to 11.x) , Microsoft SQL Server (6.x to 2005) , IBM DB2 , Sybase (4.2 to 15.x) , IBM Informix (5.x to 11.x) , Ingres (6.4 to 9.x) , Progress (7.x to 10.x) , MySQL , PostgreSQL and Firebird .
Benefits
This provider equips Microsoft .NET based applications, development environments, and programming languages with conceptual entity-based access to native and heterogeneous data sources.
Features
-
ADO.NET 3.5 compliance
-
.NET Entity Frameworks compatibility
-
Full integration with Visual Studio 2008
-
ADO.NET Data Services compatibility
-
LINQ to Entities compatibility
-
High-Performance & Scalability
-
High Security
-
Support for Native and 3rd party ODBC and JDBC accessible RDBMS engines and Web Services
-
Tested against all major .NET applications and development environments
-
Support for Microsoft Siliverlight versions 2 and 3
-
Support for .Net RIA Services
7.1.2. Installation & Configuration
There are two installation types to consider:
-
If you have an existing Virtuoso instance, or will install Virtuoso on a different host, you only need to install of the ADO.Net Provider Client on the Visual Studio host.
-
If you have no existing Virtuoso instance, you can install both the ADO.Net Provider Client and the Virtuoso Universal Server on the Visual Studio host.
Installation of the ADO.Net Provider Client on Windows
The Virtuoso ADO.Net Provider is part of the Virtuoso Client Connectivity Kit installer, and if the target Virtuoso Server installation already exists on the network this is the only component that needs to be installed.
-
Download and run the Virtuoso Client Connectivity Kit installer for your target Windows OS:
-
Choose the "run" button to allow the signed "Virtuoso Client Connectivity kit" installer to start.
Figure 7.1. Run
-
Choose the "Next" button to begin the installation process.
Figure 7.2. Installation: Next
-
Check the "I agree with license agreement" checkbox and choose the "Next" button.
Figure 7.3. Installation: Agree license
-
Choose the "Custom" option to manually select what components are installed and in which location, or choose the "Typical" or "Complete" options as recommended and skip to step 7.
Figure 7.4. Custom Install
-
If the "Custom" option what chosen, select the installation directory or leave default and choose the "Next" button to continue.
Figure 7.5. Installation
-
Select which of the ADO.NET Providers are to be installed and choose "Next" to continue.
Figure 7.6. ADO.NET Providers
-
The installer is now ready to begin the installation, choose the "Install" button to commence the process.
Figure 7.7. Install
-
The installation was successfully completed.
Figure 7.8. Completed installation
-
The installation of the Provider can be verified by checking the %WINDOWS%\assembly folder and checking that the Provider(s) chosen for installation is(are) listed - "virtado3" and/or "virtado2".
Figure 7.9. Provider
The installation of the ADO.Net Provider Client is complete.
Uninstallation
-
If you attempt to run the installer again, the following message will be displayed.
Figure 7.10. Installer message
-
The Provider can be uninstalled from the "Control Panel" -> "Programs and Features" menu, by selecting the "Virtuoso Client Connectivity kit" from the list of installed components and clicking the "unistall" option presented.
Figure 7.11. Uninstall
-
Choose "Yes" to uninstall the Virtuoso ADO.Net Provider.
Figure 7.12. Uninstall
Installation of the ADO.Net Provider Client and Virtuoso Universal Server on Windows
If both the ADO.Net Provider client and Virtuoso Server are to be installed on the same Windows machine, then the Virtuoso Universal Server installer can be used as it includes all the Virtuoso client and server components available in a single installer. An instance in which this particular installation type is require would be when using the Provider to provide Entity Framework connectivity to the remote database schema objects.
-
Download and run the Virtuoso Universal Server installer for your target Windows OS:
-
Choose the "run" button to allow the signed "Virtuoso Universal Server" installer to start.
Figure 7.13. Run
-
Choose the "Next" button to begin the installation process.
Figure 7.14. Next
-
Check the "I agree with license agreement" checkbox and choose the "Next" button.
Figure 7.15. Agree license
-
Choose the "Custom" option to manually select what components are installed and in which location, or choose the "Typical" or "Complete" options as recommended and skip to step 7.
Figure 7.16. Custom option
-
If the "Custom" option what chosen, select the installation directory or leave default and choose the "Next" button to continue.
Figure 7.17. Installation directory
-
Select which of the ADO.NET Providers are to be installed and choose "Next" to continue.
Figure 7.18. ADO.NET Providers
-
The installer is now ready to begin the installation, choose the "Install" button to commence the process.
Figure 7.19. Begin installation
-
The installation was successfully completed.
Figure 7.20. Installation completed
-
Post installation the Virtuoso Server can be started by running the "Virtuoso Service Manager" which gets added to the Windows "Icons Tray" in the status bar.
Figure 7.21. Post installation
-
Double click on the "Virtuoso Service Manager" icon in the "Icons Tray" to load the application, select the "OpenLink Virtuoso Server" instance and press the "Start" button to run the Service.
Figure 7.22. Virtuoso Service Manager
-
Once the Virtuoso service has successfully started, it is *recommended* that the default "dba" and "dav" passwords be changed to secure values by loading the URL "http://example.com/install" in a Web Browser which loads the following page for making these changes.
Figure 7.23. Defaults
-
The Virtuoso Server is now available for use.
Figure 7.24. Virtuoso Server
-
The installation of the ADO.Net Provider can be verified by checking the %WINDOWS%\assembly folder and checking that the Provider(s) chosen for installation is(are) listed - "virtado3" and/or "virtado2".
Figure 7.25. Installation verification
The installation of the ADO.Net Provider Client and Virtuoso Universal Server is complete.
Uninstallation
-
If you attempt to run the installer again, the following message will be displayed.
Figure 7.26. Installer message
-
The Provider can be uninstalled from the "Control Panel" -> "Programs and Features" menu, by selecting the "Virtuoso Client Connectivity kit" from the list of installed components and clicking the "unistall" option presented.
Figure 7.27. Uninstall
-
Choose "Yes" to uninstall the Virtuoso ADO.Net Provider.
Figure 7.28. Uninstall
7.1.3. Programmers Guide
Sample Walk through Applications
-
Using Visual Studio 2008 to Build a Data Grid Form Application
-
Using Visual Studio 2008 to Build an Entity Frameworks based Windows Form Application
-
Using Visual Studio 2008 to Build an ADO.NET Data Services based Application
-
Creating A Simple .NET RIA Services Application to Display Data from Virtuoso
-
Creating a .Net RIA Services Application that will Update Virtuoso Data
Using Entity Frameworks, ADO.NET, the Virtuoso Virtual Database Engine
Virtuoso's in-built virtual database engine for ODBC and JDBC accessible databases enables it to act as bridge between Entity Frameworks & ADO.NET based client applications. Thus, you simply link external databases into Virtuoso using the browser based Conductor UI or programmatically using SQL extensions. Once the external tables a linked/attached, they inherit the functionality prowess of Virtuoso, and this particular use case scenario, complete compatibility with Entity Frameworks and ADO.NET 3.5.
-
Using Microsoft Entity Frameworks to Access Oracle Schema Objects with Virtuoso
-
Using Microsoft Entity Frameworks to Access Progress Schema Objects with Virtuoso
-
Using Microsoft Entity Frameworks to Access Ingres Schema Objects with Virtuoso
-
Using Microsoft Entity Frameworks to Access Informix Schema Objects with Virtuoso
-
Using Microsoft Entity Frameworks to Access DB2 Schema Objects with Virtuoso
-
Using Microsoft Entity Frameworks to Access Sybase Schema Objects with Virtuoso
-
Using Microsoft Entity Frameworks to Access MySQL Schema Objects with Virtuoso
-
Using Microsoft Entity Frameworks to Access PostgreSQL Schema Objects with Virtuoso
-
Using Microsoft Entity Frameworks to Access JDBC Schema Objects with Virtuoso
-
Using Microsoft Entity Frameworks to Access ODBC Schema Objects with Virtuoso
-
Using Microsoft Entity Frameworks to Access Firebird Schema Objects with Virtuoso
-
Using Microsoft Entity Frameworks to Access Microsoft SQL Server Schema Objects with Virtuoso
VirtDbType Enumeration
Specifies Virtuoso data types.
Members
Table 7.1.
Member name | Description |
---|---|
Binary
|
BINARY data. This maps to an Array of type Byte . |
Char
|
CHAR data. This maps to String . |
Date
|
DATE data. This maps to DateTime . |
DateTime
|
DATETIME data. This maps to DateTime . |
Decimal
|
This is equal to Numeric
. |
Double
|
DOUBLE PRECISION data. This maps to Double . |
Float
|
This is equal to Double. |
Integer
|
INTEGER data. This maps to Int32 |
LongBinary
|
LONG BINARY data. This maps to an Array of type Byte . |
LongNVarChar
|
LONG NVARCHAR data. This maps to String . |
LongVarChar
|
LONG VARCHAR data. This maps to String . |
NChar
|
NChar data. This maps to String . |
Numeric
|
NUMERIC data. This maps to Decimal |
NVarChar
|
NVARCHAR data. This maps to String . |
Real
|
REAL data, This maps to Single . |
SmallInt
|
SMALLINT data. This maps to Int16 |
Time
|
TIME data. This maps to TimeSpan |
TimeStamp
|
TIMESTAMP data. This maps to an Array of type Byte . |
VarBinary
|
VARBINARY data. This maps to an Array of type Byte . |
VarChar
|
VARCHAR data. This maps to String . |
VirtuosoCommand Class
Represents an SQL statement or stored procedure to execute against a Virtuoso database. This class cannot be inherited.
Figure 7.29. Virtuoso .Net Provider VirtuosoCommand Class
public sealed class VirtuosoCommand extends, Component
implements, ICloneable , IDbCommand {
}
Thread Safety
Any public static (Shared in Visual Basic) members of this type are safe for multithreaded operations. Any instance members are not guaranteed to be thread safe.
Remarks
The VirtuosoCommand class provides the following methods for executing commands against a Virtuoso database:
Table 7.2.
Item | Description |
---|---|
ExecuteReader | Executes commands that return rows. |
ExecuteNonQuery | Executes commands such as SQL INSERT, DELETE, UPDATE, and SET statements. |
ExecuteScalar | Retrieves a single value (for example, an aggregate value) from a database. |
VirtuosoCommand Constructor
Initializes a new instance of the VirtuosoCommand class.
VirtuosoCommand Constructor ()
Initializes a new instance of the VirtuosoCommand class.
public VirtuosoCommand();
Remarks
The base constructor initializes all fields to their default values. The following table shows initial property values for an instance of VirtuosoCommand.
Table 7.3.
Properties | Initial Value |
---|---|
CommandText | empty string ("") |
CommandTimeout | 30 |
CommandType | CommandType.Text |
Connection | null |
You can change the value for any of these properties through a separate call to the property.
VirtuosoCommand Constructor (string)
Initializes a new instance of the VirtuosoCommand class with the text of the query.
public VirtuosoCommand(
string
cmdText
);
VirtuosoCommand Constructor (string, VirtuosoConnection)
Initializes a new instance of the VirtuosoCommand class with the text of the query and an VirtuosoConnection object.
public VirtuosoCommand(
string
cmdText
,
VirtuosoConnection
connection
);
Parameters
- cmdText
-
The text of the query.
- connection
-
A VirtuosoConnection object that represents the connection to a Virtuoso database.
ConnectionString Property
The Virtuoso ADO.NET Provider ConnectionString property implements the IDbConnection.ConnectionString property to get or set the string used to open a Virtuoso database connection, and includes the source database name and other parameters needed to establish the initial connection. The default value is an empty string.
public
string
ConnectionString
;
Property Value
Includes the source database name and other parameters needed to establish the initial connection. The default value is an empty string.
ConnectionString has the following syntax: Each connection string is a sequence of settings Individual settings are separated by semicolons. Each setting is a pair of name and value delimited by the equal sign. Whitespace is ignored on either side of both names and values. Names are case insensitive. The value part can be quoted by either single or double quote characters or remain unquoted at all. However if it includes a semicolon, single quote, or double quote characters, it must be enclosed in either type of quotes. To embed the same character that is used for enclosing the value the character within the value must be doubled.
The following table lists the valid names for values within the ConnectionString:
Table 7.4.
Name | Default | Description |
---|---|---|
Connect Timeout or Connection Timeout | 15 | The number of seconds to wait for a connection to the server before terminating the attempt and generating an error. |
Connection Lifetime | 0 | When a connection is returned to the pool, its creation time is compared with the current time, and the connection is destroyed if that time span (in seconds) exceeds the value specified by connection lifetime. Useful in clustered configurations to force load balancing between a running server and a server just brought on-line. |
Charset | utf-16 | Specifies the character set to be used by the provider when passing string values to and from the database. Must be set to utf-8 to handle Unicode strings passed in SPARQL/SPASQL queries of RDF data. |
Data Source or Server or Address or Network Address or Host | The name or network address of the instance of Virtuoso server to which to connect. Can take comma delimited list of instances for connection fail over. | |
Encrypt | false | Specifies if the connection must be SSL encrypted. Currently encryption only works with an ODBC-based provider. |
Enlist | true | When true, the pooler automatically enlists the connection in the creation thread's current transaction context. |
Initial Catalog or Database | The name of the database. | |
Max Pool Size | 100 | The maximum number of connections allowed in the pool. |
Min Pool Size | 0 | The minimum number of connections allowed in the pool. |
Password or Pwd | The password for the Virtuoso account logging on. | |
Persist Security Info | false | When set to 'false', security-sensitive information, such as the password, is not returned as part of the connection if the connection is open or has ever been in an open State. Resetting the connection string resets all connection string values including the password. |
Pooling | true | When true, the VirtuosoConnection object is drawn from the appropriate pool, or if necessary, is created and added to the appropriate pool. |
RoundRobin | false | Enables load balancing in which case the server for the connection is chosen at random from the comma delimited provided as for a Failover connection. |
User ID or Uid | The Virtuoso login name. |
Remarks
The ConnectionString is similar to an OLE DB connection string, but is not identical. Unlike OLE DB or ADO, the connection string that is returned is the same as the user set ConnectionString minus security information if the Persist Security Info value is set to false (default). The Virtuoso ADO.NET Data Provider neither persists nor returns the password in a connection string unless you set Persist Security Info to true.
The ConnectionString property can be set only when the connection is closed. Many of the connection string values have corresponding read-only properties. When the connection string is set, all of these properties are updated, except when an error is detected; in this case, none of the properties are updated. VirtuosoConnection properties return only those settings contained in the ConnectionString .
Resetting the ConnectionString on a closed connection resets all connection string values (and related properties) including the password. For example, if you set a connection string that includes "Database=Demo ", and then reset the connection string to "Data Source=myserver;User ID=dba;Password=dba ", the Database property is no longer set to Demo .
The connection string is parsed immediately after being set. If errors in syntax are found when parsing, a runtime exception (e.g., ArgumentException ) is generated. Other errors can be found only when an attempt is made to open the connection.
VirtuosoCommand Constructor (string, VirtuosoConnection, VirtuosoTransaction)
Initializes a new instance of the VirtuosoCommand class with the text of the query, an VirtuosoConnection object, and the VirtuosoTransaction.
public VirtuosoCommand(
string
cmdText
,
VirtuosoConnection
connection
,
VirtuosoTransaction
transaction
);
Parameters
- cmdText
-
The text of the query.
- connection
-
A VirtuosoConnection object that represents the connection to a Virtuoso database.
- transaction
-
The VirtuosoTransaction in which the VirtuosoCommand executes.
Properties
CommandText Property
Gets or sets the SQL statement or stored procedure to execute against the Virtuoso database.
public
string
CommandText
;
Property Value
The SQL statement or stored procedure to execute. The default value is an empty string ("").
Remarks
When the CommandType property is set to StoredProcedure, the CommandText property should be set using standard ODBC stored procedure escape sequences. Setting the CommandText to the name of the stored procedure does not function as it does for some other .NET data providers.
The Virtuoso .NET Data Provider does not support named parameters for passing parameters to a SQL statement or a stored procedure called by an OleDbCommand when CommandType is set to Text. In this case, the question mark (?) placeholder must be used. For example:
SELECT * FROM Customers WHERE CustomerID = ?
As a result, the order in which VirtuosoParameter objects are added to the VirtuosoParameterCollection must directly correspond to the position of the question mark placeholder for the parameter.
CommandTimeout Property
Gets or sets the wait time before terminating an attempt to execute a command and generating an error.
public
int
CommandTimeout
;
Property Value
The time (in seconds) to wait for the command to execute. The default is 30 seconds.
Remarks
A value of zero (0) specifies no limit to the wait time, rather than no wait time, and therefore should be avoided.
CommandType Property
Gets or sets a value indicating how the CommandText property is interpreted.
public
CommandType
CommandType
;
Remarks
When the CommandType property is set to StoredProcedure, you should set the CommandText property to the full ODBC call syntax. The command then executes this stored procedure when you call one of the Execute methods (for example, ExecuteReader or ExecuteNonQuery).
The Connection, CommandType and CommandText properties cannot be set if the current connection is performing an execute or fetch operation.
The Virtuoso .NET Data Provider does not support passing named parameters to an SQL statement or to a stored procedure called by a VirtuosoCommand. In either of these cases, use the question mark (?) placeholder. For example:
SELECT * FROM Customers WHERE CustomerID = ?
The order in which VirtuosoParameter objects are added to the VirtuosoParameterCollection must directly correspond to the position of the question mark placeholder for the parameter.
Connection Property
Gets or sets the VirtuosoConnection used by this instance of the VirtuosoCommand.
public
VirtuosoConnection
Connection
;
Parameters Property
Gets the VirtuosoParameterCollection.
public
VirtuosoParameterCollection
Connection
;
Property Value
The parameters of the SQL statement or stored procedure. The default is an empty collection.
Remarks
When CommandType is set to Text, the Virtuoso .NET Data Provider does not support passing named parameters to an SQL statement or to a stored procedure called by an VirtuosoCommand. In either of these cases, use the question mark (?) placeholder. For example:
SELECT * FROM Customers WHERE CustomerID = ?
The order in which VirtuosoParameter objects are added to the VirtuosoParameterCollection must directly correspond to the position of the question mark placeholder for the parameter in the command text.
Note: | |
---|---|
If the parameters in the collection do not match the requirements of the query to be executed, an error may result. |
Transaction Property
Gets or sets the VirtuosoTransaction within which the VirtuosoCommand executes.
public
VirtuosoTransaction
Transaction
;
Remarks
You cannot set the Transaction property if it is already set to a specific value, and the command is in the process of executing. If you set the transaction property to an VirtuosoTransaction object that is not connected to the same VirtuosoConnection as the VirtuosoCommand object, an exception will be thrown the next time you attempt to execute a statement.
Methods
Remarks
If there is nothing to cancel, nothing happens. However, if there is a command in process, and the attempt to cancel fails, no exception is generated.
CreateParameter Method
Creates a new instance of a VirtuosoParameter object.
public VirtuosoParameter CreateParameter();
ExecuteNonQuery Method
Executes an SQL statement against the Connection and returns the number of rows affected.
public int ExecuteNonQuery();
Return Value
For UPDATE, INSERT, and DELETE statements, the return value is the number of rows affected by the command. For all other types of statements, the return value is -1.
Remarks
You can use ExecuteNonQuery to perform catalog operations (for example, querying the structure of a database or creating database objects such as tables); or to change the data in a database, without using a DataSet, by executing UPDATE, INSERT, or DELETE statements.
Although ExecuteNonQuery does not return any rows, any output parameters or return values mapped to parameters are populated with data.
ExecuteReader Method
Sends the CommandText to the Connection and builds a VirtuosoDataReader.
ExecuteReader Method ()
Sends the CommandText to the Connection and builds a VirtuosoDataReader.
public VirtuosoDataReader ExecuteReader();
ExecuteReader Method (CommandBehavior)
Sends the CommandText to the Connection and builds a VirtuosoDataReader using one of the CommandBehavior values.
public VirtuosoDataReader ExecuteReader(
CommandBehavior
behavior
);
ExecuteScalar Method
Executes the query, and returns the first column of the first row in the resultset returned by the query. Extra columns or rows are ignored.
public object ExecuteScalar();
Remarks
Use the ExecuteScalar method to retrieve a single value (for example, an aggregate value) from a database. This requires less code than using the ExecuteReader method, and then performing the operations necessary to generate the single value using the data returned by a VirtuosoDataReader.
A typical ExecuteScalar query can be formatted as in the following C# example:
command.CommandText = "select count(*) from foobar"; int count = (int) command.ExecuteScalar();
ICloneable.Clone Method
This member supports the .NET Framework infrastructure and is not intended to be used directly from your code.
object ICloneable.Clone();
IDbCommand.CreateParameter Method
This member supports the .NET Framework infrastructure and is not intended to be used directly from your code.
IDbDataParameter IDbCommand.CreateParameter();
IDbCommand.ExecuteReader Method
This member supports the .NET Framework infrastructure and is not intended to be used directly from your code.
IDbCommand.ExecuteReader Method ()
This member supports the .NET Framework infrastructure and is not intended to be used directly from your code.
IDataReader IDbCommand.ExecuteReader();
IDbCommand.ExecuteReader Method (CommandBehavior)
This member supports the .NET Framework infrastructure and is not intended to be used directly from your code.
IDataReader IDbCommand.ExecuteReader(
CommandBehavior
behavior
);
VirtuosoCommandBuilder Class
Provides a means of automatically generating single-table commands used to reconcile changes made to a DataSet with the associated Virtuoso database. This class cannot be inherited.
System.Object |
System.MarshalByRefObject |
System.ComponentModel.Component |
VirtuosoCommandBuilder |
public sealed class VirtuosoCommandBuilder extends, Component {
}
Thread Safety
Any public static (Shared in Visual Basic) members of this type are safe for multithreaded operations. Any instance members are not guaranteed to be thread safe.
Remarks
The VirtuosoDataAdapter does not automatically generate the SQL statements required to reconcile changes made to a DataSet associated with the data source. However, you can create a VirtuosoCommandBuilder object that generates SQL statements for single-table updates if you set the SelectCommand property of the VirtuosoDataAdapter. Then, the VirtuosoCommandBuilder generates any additional SQL statements that you do not set.
The relationship between a VirtuosoDataAdapter and its corresponding VirtuosoCommandBuilder is always one-to-one. To create this correspondence, you set the DataAdapter property of the VirtuosoCommandBuilder object. This causes the VirtuosoCommandBuilder to register itself as a listener for RowUpdating events on the specified VirtuosoDataAdapter object.
To generate INSERT, UPDATE, or DELETE statements, the VirtuosoCommandBuilder uses the SelectCommand property to retrieve a required set of metadata. If you change the value of SelectCommand after the metadata has been retrieved (for example, after the first update), you then should call the RefreshSchema method to update the metadata.
The VirtuosoCommandBuilder also uses the Connection, CommandTimeout, and Transaction properties referenced by the SelectCommand. The user should call RefreshSchema if any of these properties are modified, or if the value of the SelectCommand property itself is changed. Otherwise the InsertCommand, UpdateCommand, and DeleteCommand properties retain their previous values.
If you call Dispose, the VirtuosoCommandBuilder is disassociated from the VirtuosoDataAdapter, and the generated commands are no longer used.
VirtuosoCommandBuilder Constructor
VirtuosoCommandBuilder Constructor ()
Initializes a new instance of the VirtuosoCommandBuilder class.
public VirtuosoCommandBuilder();
VirtuosoCommandBuilder Constructor (VirtuosoDataAdapter)
Initializes a new instance of the VirtuosoCommandBuilder class with the associated VirtuosoDataAdapter object.
public VirtuosoCommandBuilder(
VirtuosoDataAdapter
adapter
);
Remarks
The VirtuosoCommandBuilder registers itself as a listener for RowUpdating events that are generated by the VirtuosoDataAdapter specified in this property.
Properties
DataAdapter Property
Gets or sets a VirtuosoDataAdapter object for which SQL statements are automatically generated.
public
VirtuosoDataAdapter
DataAdapter
;
Remarks
The VirtuosoCommandBuilder registers itself as a listener for RowUpdating events that are generated by the VirtuosoDataAdapter specified in this property.
QuotePrefix Property
Gets or sets the beginning character or characters to use when working with database objects (for example, tables or columns) whose names contain characters such as spaces.
public
string
QuotePrefix
;
Remarks
Database objects in Virtuoso servers can contain any valid characters, including spaces, commas, and semicolons. To accommodate this capability, use the QuotePrefix and QuoteSuffix properties to specify delimiters such as a left bracket and a right bracket to encapsulate the object name.
QuoteSuffix Property
Gets or sets the ending character or characters to use when working with database objects (for example, tables or columns) whose names contain characters such as spaces.
public
string
QuotePrefix
;
Remarks
Database objects in Virtuoso servers can contain any valid characters, including spaces, commas, and semicolons. To accommodate this capability, use the QuotePrefix and QuoteSuffix properties to specify delimiters such as a left bracket and a right bracket to encapsulate the object name.
Methods
DeriveParameters Method
Retrieves parameter information from the stored procedure specified in the VirtuosoCommand and populates the Parameters collection of the specified VirtuosoCommand object.
public static void DeriveParameters(
VirtuosoCommand
command
);
Parameters
- command
-
The VirtuosoCommand referencing the stored procedure from which the parameter information is to be derived. The derived parameters are added to the Parameters collection of the VirtuosoCommand.
Remarks
DeriveParameters
overwrites any existing parameter information for
the VirtuosoCommand. DeriveParameters
requires an extra call to the data server to obtain
the information. If the parameter information is known in advance, it is more efficient to populate the parameters
collection by setting the information explicitly.
For more information, see "Using Stored Procedures with a Command" in the Microsoft® .NET Framework SDK documentation.
Dispose Method
Releases the unmanaged and, optionally, the managed resources used by the VirtuosoCommandBuilder.
protected override void Dispose(
bool
disposing
);
Parameters
- disposing
-
true
to release both managed and unmanaged resources;false
to release only unmanaged resources.
Remarks
This method is called by the public Dispose method and the Finalize method. Dispose() invokes the protected Dispose(Boolean) method with the disposing parameter set to true. Finalize invokes Dispose with disposing set to false.
When the disposing parameter is true, the method releases all resources held by any managed objects that this VirtuosoCommand references. It does this by invoking the Dispose() method of each referenced object.
For more information about Dispose and Finalize, see "Cleaning Up Unmanaged Resources," and "Overriding the Finalize Method," in the .NET Framework SDK documentation.
GetDeleteCommand Method
Gets the automatically generated VirtuosoCommand object required to perform deletions on the Virtuoso database.
public VirtuosoCommand GetDeleteCommand();
Remarks
You can use the GetDeleteCommand method for informational or troubleshooting purposes because it returns the VirtuosoCommand object to be executed.
You can also use GetDeleteCommand as the basis of a modified command. For example, you might call GetDeleteCommand and modify the CommandTimeout value, and then explicitly set that on the VirtuosoDataAdapter.
After the SQL statement is first generated, you must explicitly call RefreshSchema if you change the statement in any way. Otherwise, the GetDeleteCommand still will be using information from the previous statement, which might not be correct. The SQL statements are first generated when the application calls either Update or GetDeleteCommand.
GetInsertCommand Method
Gets the automatically generated VirtuosoCommand object required to perform insertions on the Virtuoso database.
public VirtuosoCommand GetInsertCommand();
Remarks
You can use the GetInsertCommand method for informational or troubleshooting purposes because it returns the VirtuosoCommand object to be executed.
You can also use GetInsertCommand as the basis of a modified command. For example, you might call GetInsertCommand and modify the CommandTimeout value, and then explicitly set that on the VirtuosoDataAdapter.
After the SQL statement is first generated, you must explicitly call RefreshSchema if you change the statement in any way. Otherwise, the GetInsertCommand still will be using information from the previous statement, which might not be correct. The SQL statements are first generated when the application calls either Update or GetInsertCommand.
GetUpdateCommand Method
Gets the automatically generated VirtuosoCommand object required to perform updates on the Virtuoso database.
public VirtuosoCommand GetUpdateCommand();
Remarks
You can use the GetUpdateCommand method for informational or troubleshooting purposes because it returns the VirtuosoCommand object to be executed.
You can also use GetUpdateCommand as the basis of a modified command. For example, you might call GetUpdateCommand and modify the CommandTimeout value, and then explicitly set that on the VirtuosoDataAdapter.
After the SQL statement is first generated, you must explicitly call RefreshSchema if you change the statement in any way. Otherwise, the GetUpdateCommand still will be using information from the previous statement, which might not be correct. The SQL statements are first generated when the application calls either Update or GetUpdateCommand.
VirtuosoConnection Class
Represents an open connection to a Virtuoso database. This class cannot be inherited.
System.Object |
System.MarshalByRefObject |
System.ComponentModel.Component |
VirtuosoConnection |
public sealed class VirtuosoConnection extends, Component
implements, ICloneable , IDbConnection {
}
Thread Safety
Any public static (Shared in Visual Basic) members of this type are safe for multithreaded operations. Any instance members are not guaranteed to be thread safe.
Remarks
A VirtuosoConnection object represents a unique session to a Virtuoso database server.
The VirtuosoConnection object uses native resources such as network connection handles. You should always explicitly close any open VirtuosoConnection objects by calling Close or Dispose before the VirtuosoConnection object goes out of scope. Not doing so leaves the freeing of these native resources to garbage collection, which may not free them immediately. This, in turn, may eventually cause the underlying driver to run out of resources or reach a maximum limit, resulting in sporadic failures. For example, you might encounter Maximum Connections-related errors while a number of connections are waiting to be deleted by the garbage collector. Explicitly closing the connections by calling Close or Dispose allows a more efficient use of native resources, enhancing scalability and improving overall application performance.
VirtuosoConnection Constructor
Initializes a new instance of the VirtuosoConnection class.
VirtuosoConnection Constructor ()
Initializes a new instance of the VirtuosoConnection class.
public VirtuosoConnection();
Remarks
When a new instance of VirtuosoConnection is created, the read/write properties are set to the following initial values unless they are specifically set using their associated keywords in the ConnectionString property.
Table 7.5.
Properties | Initial Value |
---|---|
ConnectionString | empty string ("") |
ConnectionTimeout | 15 |
Database | empty string ("") |
You can change the value for these properties only by using the ConnectionString property
VirtuosoConnection Constructor (string)
Initializes a new instance of the VirtuosoConnection class with the specified connection string.
public VirtuosoConnection(
string
connectionString
);
Remarks
When a new instance of VirtuosoConnection is created, the read/write properties are set to the following initial values unless they are specifically set using their associated keywords in the ConnectionString property.
Table 7.6.
Properties | Initial Value |
---|---|
ConnectionString | connectionString |
ConnectionTimeout | 15 |
Database | empty string ("") |
You can change the value for these properties only by using the ConnectionString property
Properties
ConnectionString Property
Gets or sets the string used to open a Virtuoso database.
public
string
ConnectionString
;
Property Value
The connection string that includes the source database name, and other parameters needed to establish the initial connection. The default value is an empty string.
Remarks
The ConnectionString is similar to an OLE DB connection string, but is not identical.
Unlike OLE DB or ADO, the connection string that is returned is the same as the user-set ConnectionString
minus security information if the Persist Security
Info value is set to
false
(default). The Virtuoso .NET Data Provider does not persist or return the
password in a connection string unless you set Persist Security Info
to true.
The ConnectionString property can be set only when the connection is closed. Many of the connection string values have corresponding read-only properties. When the connection string is set, all of these properties are updated, except when an error is detected. In this case, none of the properties are updated. VirtuosoConnection properties return only those settings contained in the ConnectionString.
Resetting the ConnectionString on a closed connection resets all connection string values (and related properties) including the password. For example, if you set a connection string that includes "Database=Demo", and then reset the connection string to "Data Source=myserver;User ID=dba;Password=dba", the Database property is no longer set to northwind.
The connection string is parsed immediately after being set. If errors in syntax are found when parsing, a runtime exception, such as ArgumentException, is generated. Other errors can be found only when an attempt is made to Open the connection.
Connection string has the following syntax. Each connection string is a sequence of settings Individual settings are separated by semicolons. Each setting is a pair of name and value delimited by the equal sign. Whitespace is ignored on either side of both names and values. Names are case insensitive. The value part can be quoted by either single or double quote characters or remain unquoted at all. However if it includes a semicolon, single quote, or double quote characters, it must be enclosed in either type of quotes. To embed the same character that is used for enclosing the value the character within the value must be doubled.
The following table lists the valid names for values within the ConnectionString.
Table 7.7.
Name | Default | Description |
---|---|---|
Connect Timeout -or- Connection Timeout |
15 | The length of time (in seconds) to wait for a connection to the server before terminating the attempt and generating an error. |
Connection Lifetime | 0 | When a connection is returned to the pool, its creation time is compared with the current time, and the connection is destroyed if that time span (in seconds) exceeds the value specified by connection lifetime. Useful in clustered configurations to force load balancing between a running server and a server just brought on-line. |
Data Source -or- Server -or- Address -or- Network Address |
The name or network address of the instance of Virtuoso server to which to connect. | |
Encrypt | false | Specifies if the connection must be SSL encrypted. Currently encryption only works with an ODBC-based provider. |
Enlist | true | When true, the pooler automatically enlists the connection in the creation thread's current transaction context. |
Initial Catalog -or- Database |
The name of the database. | |
Max Pool Size | 100 | The maximum number of connections allowed in the pool. |
Min Pool Size | 0 | The minimum number of connections allowed in the pool. |
Password -or- Pwd |
The password for the Virtuoso account logging on. | |
Persist Security Info | false | When set to 'false', security-sensitive information, such as the password, is not returned as part of the connection if the connection is open or has ever been in an open State. Resetting the connection string resets all connection string values including the password |
Pooling | true | When true, the VirtuosoConnection object is drawn from the appropriate pool, or if necessary, is created and added to the appropriate pool. |
User ID -or- Uid |
The Virtuoso login name. |
ConnectionTimeout Property
Gets or sets the time to wait while trying to establish a connection before terminating the attempt and generating an error.
public
int
ConnectionTimeout
;
Property Value
The time (in seconds) to wait for a connection to open. The default value is 15 seconds.
Remarks
A value of 0 indicates no limit, and should be avoided in a ConnectionString because an attempt to connect will wait indefinitely.
Database Property
Gets the name of the current database or the database to be used after a connection is opened.
public
string
Database
;
Property Value
The name of the current database or the name of the database to be used once a connection is open. The default value is an empty string.
Remarks
Initially, the Database property is set in the connection string. The Database property can be updated by using the ChangeDatabase method.
Methods
BeginTransaction Method
Begins a database transaction.
BeginTransaction Method ()
Begins a database transaction.
public VirtuosoTransaction BeginTransaction();
Remarks
To commit or roll back the transaction, you must explicitly use the Commit or Rollback methods.
To ensure that the Virtuoso .NET Data Provider transaction management model performs correctly, avoid using other transaction management models, such as those provided by the data source.
BeginTransaction Method (IsolationLevel)
Begins a database transaction with the specified isolation level.
public VirtuosoTransaction BeginTransaction(
IsolationLevel
isoLevel
);
Remarks
To commit or roll back the transaction, you must explicitly use the Commit or Rollback methods.
To ensure that the Virtuoso .NET Data Provider transaction management model performs correctly, avoid using other transaction management models, such as those provided by the data source.
ChangeDatabase Method
Changes the current database for an open VirtuosoConnection.
public void ChangeDatabase(
string
database
);
Remarks
The value parameter must contain a valid database name, and cannot contain a null value, an empty string (""), or a string with only blank characters.
Close Method
Closes the connection to the database. This is the preferred method of closing any open connection.
public void Close();
Remarks
The Close method rolls back any pending transactions. It then releases the connection to the connection pool, or closes the connection if connection pooling is disabled.
An application can call Close more than one time. No exception is generated.
CreateCommand Method
Creates and returns a VirtuosoCommand object associated with the VirtuosoConnection.
public VirtuosoCommand CreateCommand();
EnlistDistributedTransaction Method
Enlists in the specified transaction as a distributed transaction.
public void EnlistDistributedTransaction(
ITransaction
transaction
);
Parameters
- transaction
-
A reference to an existing transaction in which to enlist or null to unenlist.
Remarks
You can enlist in an existing distributed transaction using the EnlistDistributedTransaction method if auto-enlistment is disabled. Enlisting in an existing distributed transaction ensures that, if the transaction is committed or rolled back, modifications made by the code at the data source are also committed or rolled back.
ICloneable.Clone Method
This member supports the Microsoft® .NET Framework infrastructure and is not intended to be used directly from your code.
object ICloneable.Clone();
IDbConnection.BeginTransaction Method
This member supports the Microsoft® .NET Framework infrastructure and is not intended to be used directly from your code.
IDbConnection.BeginTransaction Method ()
This member supports the Microsoft® .NET Framework infrastructure and is not intended to be used directly from your code.
IDbTransaction IDbConnection.BeginTransaction();
IDbConnection.BeginTransaction Method (IsolationLevel)
This member supports the Microsoft® .NET Framework infrastructure and is not intended to be used directly from your code.
IDbTransaction IDbConnection.BeginTransaction(
IsolationLevel
isoLevel
);
IDbConnection.CreateCommand Method
This member supports the Microsoft® .NET Framework infrastructure and is not intended to be used directly from your code.
IDbCommand IDbConnection.CreateCommand();
Open Method
Opens a database connection with the property settings specified by the ConnectionString.
public void Open();
Remarks
The VirtuosoConnection draws an open connection from the connection pool if one is available. Otherwise, it establishes a new connection to an instance of Virtuoso server.
Note: | |
---|---|
If the VirtuosoConnection goes out of scope, it is not closed. Therefore, you must explicitly close the connection by calling Close or Dispose. |
VirtuosoDataAdapter Class
Represents a set of data commands and a connection to a data source that are used to fill the DataSet and update the data source. This class cannot be inherited.
System.Object |
System.MarshalByRefObject |
System.ComponentModel.Component |
System.Data.Common.DataAdapter |
System.Data.Common.DbDataAdapter |
VirtuosoDataAdapter |
public sealed class VirtuosoDataAdapter extends, DbDataAdapter
implements, IDbDataAdapter {
}
Thread Safety
Any public static (Shared in Microsoft® Visual Basic®) members of this type are safe for multithreaded operations. Any instance members are not guaranteed to be thread safe.
Remarks
The VirtuosoDataAdapter serves as a bridge between a DataSet and data source for retrieving and saving data. The VirtuosoDataAdapter provides this bridge by using Fill to load data from the data source into the DataSet, and using Update to send changes made in the DataSet back to the data source.
The VirtuosoDataAdapter also includes the SelectCommand, InsertCommand, DeleteCommand, UpdateCommand, and TableMappings properties to facilitate loading and updating of data.
VirtuosoDataAdapter Constructor
VirtuosoDataAdapter Constructor ()
Initializes a new instance of the VirtuosoDataAdapter class.
public VirtuosoDataAdapter();
Remarks
When you create an instance of VirtuosoDataAdapter, the following read/write properties are set to their default values, as shown in the table.
Table 7.8.
Properties | Default Value |
---|---|
MissingMappingAction | MissingMappingAction.Passthrough |
MissingSchemaAction | MissingSchemaAction.Add |
You can change the value of any of these properties through a separate call to the property.
VirtuosoDataAdapter Constructor (VirtuosoCommand)
Initializes a new instance of the VirtuosoDataAdapter class with the specified VirtuosoCommand as the SelectCommand property.
public VirtuosoDataAdapter(
VirtuosoCommand
selectCommand
);
Parameters
- selectCommand
-
A VirtuosoCommand that is an SQL SELECT statement or stored procedure, and is set as the SelectCommand property of the VirtuosoDataAdapter.
Remarks
This implementation of the VirtuosoDataAdapter constructor sets the SelectCommand property to the value specified in the selectCommand parameter.
When you create an instance of VirtuosoDataAdapter, the following read/write properties are set to their default values, as shown in the table.
Table 7.9.
Properties | Default Value |
---|---|
MissingMappingAction | MissingMappingAction.Passthrough |
MissingSchemaAction | MissingSchemaAction.Add |
You can change the value of any of these properties through a separate call to the property.
VirtuosoDataAdapter Constructor (string, VirtuosoConnection)
Initializes a new instance of the VirtuosoDataAdapter class with an SQL SELECT statement and a VirtuosoConnection.
public VirtuosoDataAdapter(
string
selectCommandText
,
VirtuosoConnection
selectConnection
);
Parameters
- selectCommandText
-
A string that is a SQL SELECT statement or stored procedure to be used by the SelectCommand property of the VirtuosoDataAdapter.
- selectConnection
-
A VirtuosoConnection that represents the connection.
VirtuosoDataAdapter Constructor (string, string)
Initializes a new instance of the VirtuosoDataAdapter class with an SQL SELECT statement and a connection string.
public VirtuosoDataAdapter(
string
selectCommandText
,
string
selectConnectionString
);
Parameters
- selectCommandText
-
A string that is a SQL SELECT statement or stored procedure to be used by the SelectCommand property of the VirtuosoDataAdapter.
- selectConnectionString
-
The connection string.
Properties
DeleteCommand
Gets or sets an SQL statement or stored procedure used to delete records in the data source.
public
VirtuosoCommand
DeleteCommand
;
Property Value
A VirtuosoCommand used during an update operation to delete records in the database that correspond to deleted rows in the DataSet.
Remarks
When DeleteCommand is assigned to a previously created VirtuosoCommand, the VirtuosoCommand is not cloned. The DeleteCommand maintains a reference to the previously created VirtuosoCommand object.
InsertCommand
Gets or sets an SQL statement or stored procedure used to insert new records in the data source.
public
VirtuosoCommand
InsertCommand
;
Property Value
A VirtuosoCommand used during an update operation to insert records in the database that correspond to new rows in the DataSet.
Remarks
When InsertCommand is assigned to a previously created VirtuosoCommand, the VirtuosoCommand is not cloned. The InsertCommand maintains a reference to the previously created VirtuosoCommand object.
SelectCommand
Gets or sets an SQL statement or stored procedure used to select records in the data source.
public
VirtuosoCommand
SelectCommand
;
Property Value
A VirtuosoCommand used during Fill to select records from the database for placement in the DataSet.
Remarks
When SelectCommand is assigned to a previously created VirtuosoCommand, the VirtuosoCommand is not cloned. The SelectCommand maintains a reference to the previously created VirtuosoCommand object.
If the SelectCommand does not return any rows, no tables are added to the DataSet, and no exception is raised.
UpdateCommand
Gets or sets an SQL statement or stored procedure used to update records in the data source.
public
VirtuosoCommand
UpdateCommand
;
Property Value
A VirtuosoCommand used during an update operation to update records in the database that correspond to modified rows in the DataSet.
Remarks
When UpdateCommand is assigned to a previously created VirtuosoCommand, the VirtuosoCommand is not cloned. The UpdateCommand maintains a reference to the previously created VirtuosoCommand object.
Methods
CreateRowUpdatedEvent
This member overrides DbDataAdapter.CreateRowUpdatedEvent.
protected override RowUpdatedEventArgs CreateRowUpdatedEvent(
DataRow
dataRow
,
IDbCommand
command
,
StatementType
statementType
,
DataTableMapping
tableMapping
);
CreateRowUpdatingEvent
This member overrides DbDataAdapter.CreateRowUpdatingEvent.
protected override RowUpdatedEventArgs CreateRowUpdatingEvent(
DataRow
dataRow
,
IDbCommand
command
,
StatementType
statementType
,
DataTableMapping
tableMapping
);
OnRowUpdated
Raises the RowUpdated event.
protected override void OnRowUpdated(
RowUpdatedEventArgs
value
);
Remarks
Raising an event invokes the event handler through a delegate. For an overview, see "Raising an Event" in the Microsoft® .NET Framework SDK documentation.
Events
RowUpdated
Occurs during an Update operation after a command is executed against the data source.
public
event
VirtuosoRowUpdatedEventHandler
RowUpdated
;
Event Data
The event handler receives an argument of type VirtuosoRowUpdatedEventArgs containing data related to this event. The following VirtuosoRowUpdatedEventArgs properties provide information specific to this event.
Table 7.10.
Property | Description |
---|---|
Command | Gets the VirtuosoCommand executed when Update is called. |
Errors (inherited from RowUpdatedEventArgs) | Gets any errors generated by the .NET data provider when the Command was executed. |
RecordsAffected (inherited from RowUpdatedEventArgs) | Gets the number of rows changed, inserted, or deleted by execution of the SQL statement. |
Row (inherited from RowUpdatedEventArgs) | Gets the DataRow sent through an Update. |
StatementType (inherited from RowUpdatedEventArgs) | Gets the type of SQL statement executed. |
Status (inherited from RowUpdatedEventArgs) | Gets the UpdateStatus of the Command. |
TableMapping (inherited from RowUpdatedEventArgs) | Gets the DataTableMapping sent through an Update. |
Remarks
When using the Update method, there are two events that occur per data row updated. The order of execution is as follows:
-
The values in the DataRow are moved to the parameter values.
-
The OnRowUpdating event is raised.
-
The command executes.
-
If the UpdateRowSource enumeration is set to FirstReturnedRecord, the first returned result is placed in the DataRow.
-
If there are output parameters, they are placed in the DataRow.
-
The OnRowUpdated event is raised.
-
AcceptChanges is called.
RowUpdating
Occurs during an Update operation before a command is executed against the data source.
public
event
VirtuosoRowUpdatingEventHandler
RowUpdating
;
Event Data
The event handler receives an argument of type VirtuosoRowUpdatingEventArgs containing data related to this event. The following VirtuosoRowUpdatingEventArgs properties provide information specific to this event.
Table 7.11.
Property | Description |
---|---|
Command | Gets or sets the VirtuosoCommand to execute when Update is called. |
Errors (inherited from RowUpdatingEventArgs) | Gets any errors generated by the .NET data provider when the Command executes. |
Row (inherited from RowUpdatingEventArgs) | Gets the DataRow to send through an Update. |
StatementType (inherited from RowUpdatingEventArgs) | Gets the type of SQL statement to execute. |
Status (inherited from RowUpdatingEventArgs) | Gets the UpdateStatus of the Command. |
TableMapping (inherited from RowUpdatingEventArgs) | Gets the DataTableMapping to send through the Update. |
Remarks
When using the Update method, there are two events that occur per data row updated. The order of execution is as follows:
-
The values in the DataRow are moved to the parameter values.
-
The OnRowUpdating event is raised.
-
The command executes.
-
If the UpdateRowSource enumeration is set to FirstReturnedRecord, the first returned result is placed in the DataRow.
-
If there are output parameters, they are placed in the DataRow.
-
The OnRowUpdated event is raised.
-
AcceptChanges is called.
VirtuosoDataReader Class
Provides a means of reading a forward-only stream of rows from a Virtuoso database. This class cannot be inherited.
System.Object |
System.MarshalByRefObject |
VirtuosoDataReader |
public sealed class VirtuosoDataReader extends, MarshalByRefObject
implements, IDataReader , IDataRecord , IDisposable , IEnumerable {
}
Thread Safety
Any public static (Shared in Visual Basic) members of this type are safe for multithreaded operations. Any instance members are not guaranteed to be thread safe.
Remarks
To create a VirtuosoDataReader, you must call the ExecuteReader method of the VirtuosoCommand object, rather than directly using a constructor.
Changes made to a resultset by another process or thread while data is being read may be visible to the user of the VirtuosoDataReader. However, the precise behavior is both driver and timing dependent.
IsClosed and RecordsAffected are the only properties that you can call after the VirtuosoDataReader is closed. In some cases, you must call Close before you can call RecordsAffected.
Properties
Depth Property
Gets a value indicating the depth of nesting for the current row.
public
int
Depth
;
Remarks
The outermost table has a depth of zero. The Virtuoso .NET Data Provider does not support nesting and always returns zero.
FieldCount Property
Gets the number of columns in the current row.
public
int
FieldCount
;
Property Value
When not positioned in a valid record set, 0; otherwise the number of columns in the current record. The default is -1.
IsClosed Property
Gets a value indicating whether the data reader is closed.
public
bool
IsClosed
;
Remarks
IsClosed and RecordsAffected are the only properties that you can call after the VirtuosoDataReader is closed.
Item Property
Item Property (int)
Gets the value of the specified column in its native format given the column ordinal.
public
object
this[int i]
;
RecordsAffected Property
Gets the number of rows changed, inserted, or deleted by execution of the SQL statement.
public
int
RecordsAffected
;
Property Value
The number of rows changed, inserted, or deleted; 0 if no rows were affected or the statement failed; and -1 for SELECT statements.
Remarks
IsClosed and RecordsAffected are the only properties that you can call after the VirtuosoDataReader is closed.
Methods
Close Method
Closes the VirtuosoDataReader object.
public void Close();
Remarks
You must explicitly call the Close method when you are through using the VirtuosoDataReader to use the associated VirtuosoConnection for any other purpose.
The Close method fills in the values for output parameters, return values and RecordsAffected.
GetBoolean Method
Gets the value of the specified column as a Boolean.
public bool GetBoolean(
int
i
);
GetBytes Method
Reads a stream of bytes from the specified column offset into the buffer as an array, starting at the given buffer offset.
public long GetBytes(
int
i
,
long
fieldOffset
,
byte[]
buffer
,
int
bufferOffset
,
int
length
);
Parameters
- i
-
The zero-based column ordinal.
- fieldOffset
-
The index within the field from which to begin the read operation.
- buffer
-
The buffer into which to read the stream of bytes.
- bufferOffset
-
The index for buffer to begin the read operation.
- length
-
The number of bytes to read.
Remarks
GetBytes returns the number of available bytes in the field. In most cases this is the exact length of the field. However, the number returned may be less than the true length of the field if GetBytes has already been used to obtain bytes from the field. This may be the case, for example, if the VirtuosoDataReader is reading a large data structure into a buffer. For more information, see the SequentialAccess setting of System.Data.CommandBehavior in the Microsoft® .NET Framework SDK documentation.
If you pass a buffer that is a null value, GetBytes returns the length of the field in bytes.
GetChars Method
Reads a stream of characters from the specified column offset into the buffer as an array, starting at the given buffer offset.
public long GetChars(
int
i
,
long
fieldOffset
,
char[]
buffer
,
int
bufferOffset
,
int
length
);
Parameters
- i
-
The zero-based column ordinal.
- fieldOffset
-
The index within the field from which to begin the read operation.
- buffer
-
The buffer into which to copy data..
- bufferOffset
-
The index for buffer to begin the read operation.
- length
-
The number of characters to read.
Remarks
GetChars returns the number of available characters in the field. In most cases this is the exact length of the field. However, the number returned may be less than the true length of the field if GetChars has already been used to obtain characters from the field. This may be the case, for example, if the VirtuosoDataReader is reading a large data structure into a buffer. For more information, see the SequentialAccess setting of System.Data.CommandBehavior in the Microsoft® .NET Framework SDK documentation.
If you pass a buffer that is a null value. GetChars returns the length of the field in characters.
GetDataTypeName Method
Gets the name of the source data type.
public string GetDataTypeName(
int
i
);
GetDateTime Method
Gets the value of the specified column as a DateTime object.
public DateTime GetDateTime(
int
i
);
GetDecimal Method
Gets the value of the specified column as a Decimal object.
public decimal GetDecimal(
int
i
);
GetFieldType Method
Gets the Type that is the data type of the object.
public Type GetFieldType(
int
i
);
GetGuid Method
Gets the value of the specified column as a globally-unique identifier (GUID).
public Guid GetGuid(
int
i
);
GetInt16 Method
Gets the value of the specified column as a 16-bit signed integer.
public short GetInt16(
int
i
);
GetInt32 Method
Gets the value of the specified column as a 32-bit signed integer
public int GetInt32(
int
i
);
GetInt64 Method
Gets the value of the specified column as a 64-bit signed integer.
public long GetInt64(
int
i
);
GetOrdinal Method
Gets the column ordinal, given the name of the column.
public int GetOrdinal(
string
name
);
GetSchemaTable Method
Returns a DataTable that describes the column metadata of the VirtuosoDataReader.
public DataTable GetSchemaTable();
Remarks
For the GetSchemaTable method returns metadata about each column in the following order:
Table 7.12.
DataReader Column | Description |
---|---|
ColumnName | The name of the column; this might not be unique. If the column name cannot be determined, a null value is returned. This name always reflects the most recent naming of the column in the current view or command text. |
ColumnOrdinal | The ordinal of the column. This is zero for the bookmark column of the row, if any. Other columns are numbered starting with one. This column cannot contain a null value. |
ColumnSize | The maximum possible length of a value in the column. For columns that use a fixed-length data type, this is the size of the data type. |
NumericPrecision | If ProviderType is a numeric data type, this is the maximum precision of the column. The precision depends on the definition of the column. If ProviderType is not a numeric data type, this is a null value. |
NumericScale | If ProviderType is decimal, the number of digits to the right of the decimal point. Otherwise, this is a null value. |
DataType | Maps to the .Net Framework type of the column. |
ProviderType | The indicator of the column's data type. If the data type of the column varies from row to row, this must be Object. This column cannot contain a null value. |
IsLong | Set if the column contains a Binary Long Object (BLOB) that contains very long data. |
AllowDBNull | Set if the consumer can set the column to a null value or if the provider cannot determine whether or not the consumer can set the column to a null value. Otherwise, not set. A column may contain null values, even if it cannot be set to a null value. |
IsReadOnly | true
if the column can be modified; otherwise
false
. |
IsRowVersion | |
IsUnique | true
: No two rows in the base table-the table returned in
BaseTableName-can have the same value in this column. IsUnique is guaranteed to be true if the column
constitutes a key by itself or if there is a constraint of type UNIQUE that applies only to this column.
false
: The column can contain duplicate values in the base table. The default of this
column is false
. |
IsKey | true
: The column is one of a set of columns in the rowset that,
taken together, uniquely identify the row. The set of columns with IsKey set to true
must
uniquely identify a row in the rowset. There is no requirement that this set of columns is a minimal set of
columns. This set of columns may be generated from a base table primary key, a unique constraint or a unique
index. false
: The column is not required to uniquely identify the row. |
IsAutoIncrement | true
: The column assigns values to new rows in fixed increments.
false
: The column does not assign values to new rows in fixed increments. The default of this
column is false
. |
BaseSchemaName | The name of the schema in the data store that contains the column. A null value if the base schema name cannot be determined. The default of this column is a null value. |
BaseCatalogName | The name of the catalog in the data store that contains the column. NULL if the base catalog name cannot be determined. The default of this column is a null value. |
BaseTableName | The name of the table or view in the data store that contains the column. A null value if the base table name cannot be determined. The default of this column is a null value. |
BaseColumnName | The name of the column in the data store. This might be different than the column name returned in the ColumnName column if an alias was used. A null value if the base column name cannot be determined or if the rowset column is derived, but not identical to, a column in the data store. The default of this column is a null value. |
GetString Method
Gets the value of the specified column as a string.
public string GetString(
int
i
);
GetValue Method
Gets the value of the column at the specified ordinal in its native format.
public object GetValue(
int
i
);
GetValues Method
Gets all the attribute columns in the current row.
public int GetValues(
object[]
values
);
Remarks
For most applications, the GetValues method provides an efficient means for retrieving all columns, rather than retrieving each column individually.
You can pass an Object array that contains fewer than the number of columns contained in the resulting row. Only the amount of data the Object array holds is copied to the array. You can also pass an Object array whose length is more than the number of columns contained in the resulting row.
This method returns DBNull for null database columns.
IDisposable.Dispose Method
This member supports the Microsoft® .NET Framework infrastructure and is not intended to be used directly from your code.
void IDisposable.Dispose();
IEnumerable.GetEnumerator Method
This member supports the Microsoft® .NET Framework infrastructure and is not intended to be used directly from your code.
IEnumerable IEnumerable.GetEnumerator();
IsDBNull Method
Gets a value indicating whether the column contains non-existent or missing values.
public bool IsDBNull(
int
i
);
Remarks
To avoid raising an error, call this method to check for null column values before calling the typed Get methods (for example, GetByte, GetChar, and so on).
NextResult Method
Advances the VirtuosoDataReader to the next result, when reading the results of batch SQL statements.
public bool NextResult();
Remarks
Used to process multiple results, which can be generated by executing batch SQL statements.
By default, the VirtuosoDataReader is positioned on the first result.
VirtuosoError Class
Collects information relevant to a warning or error returned by Virtuoso server. This class cannot be inherited.
System.Object |
VirtuosoError |
public sealed class VirtuosoError {
}
Thread Safety
Any public static (Shared in Visual Basic) members of this type are safe for multithreaded operations. Any instance members are not guaranteed to be thread safe.
Remarks
This class is created by the Virtuoso .NET Data Provider when an error occurs. An instance of VirtuosoError is created and managed by the VirtuosoErrorCollection, which in turn is created by the VirtuosoException class.
VirtuosoErrorCollection Class
Collects all errors generated by the Virtuoso .NET Data Provider. This class cannot be inherited.
System.Object |
VirtuosoErrorCollection |
public sealed class VirtuosoErrorCollection implements, ICollection {
}
Thread Safety
Any public static (Shared in Visual Basic) members of this type are safe for multithreaded operations. Any instance members are not guaranteed to be thread safe.
Remarks
This class is created by VirtuosoException to collect instances of the VirtuosoError class. VirtuosoErrorCollection always contains at least one instance of the VirtuosoError class.
Methods
CopyTo Method
Copies the elements of the VirtuosoErrorCollection into an array, starting at the given index within the array.
public void CopyTo(
Array
array
,
int
i
);
GetEnumerator Method
This member supports the Microsoft® .NET Framework infrastructure and is not intended to be used directly from your code.
IEnumerable IEnumerable.GetEnumerator();
VirtuosoException Class
The exception that is thrown when Virtuoso server returns a warning or error. This class cannot be inherited.
System.Object |
System.Exception |
System.SystemException |
VirtuosoException |
public sealed class VirtuosoException extends, SystemException {
}
Thread Safety
Any public static (Shared in Visual Basic) members of this type are safe for multithreaded operations. Any instance members are not guaranteed to be thread safe.
Remarks
This class is created whenever the Virtuoso .NET Data Provider encounters an error generated by the server (Client-side errors are raised as standard common language runtime exceptions.). It always contains at least one instance of VirtuosoError.
VirtuosoInfoMessageEventArgs Class
Provides data for the InfoMessage event. This class cannot be inherited.
System.Object |
System.EventArgs |
VirtuosoInfoMessageEventArgs |
public sealed class VirtuosoInfoMessageEventArgs extends, EventArgs {
}
Thread Safety
Any public static (Shared in Visual Basic) members of this type are safe for multithreaded operations. Any instance members are not guaranteed to be thread safe.
Remarks
The InfoMessage event contains a VirtuosoErrorCollection collection with warnings sent from the Virtuoso srver.
VirtuosoInfoMessageEventHandler Delegate
Represents the method that will handle the InfoMessage event of a VirtuosoConnection.
public delegate void VirtuosoInfoMessageEventHandler(
object
sender
,
VirtuosoInfoMessageEventArgs
e
);
Parameters
The declaration of your event handler must have the same parameters as the VirtuosoInfoMessageEventHandler delegate declaration.
- sender
-
The source of the event.
- e
-
A VirtuosoInfoMessageEventArgs object that contains the event data.
Remarks
When you create a VirtuosoInfoMessageEventArgs delegate, you identify the method that will handle the event. To associate the event with your event handler, add an instance of the delegate to the event. The event handler is called whenever the event occurs, unless you remove the delegate. For more information about event handler delegates, see "Events and Delegates" in the .NET Framework SDK documentation.
VirtuosoParameter Class
Represents a parameter to an VirtuosoCommand and optionally, its mapping to a DataColumn. This class cannot be inherited.
System.Object |
System.MarshalByRefObject |
VirtuosoParameter |
public sealed class VirtuosoParameter extends, MarshalByRefObject
implements, IDbDataParameter , IDataParameter , ICloneable {
}
Thread Safety
Any public static (Shared in Visual Basic) members of this type are safe for multithreaded operations. Any instance members are not guaranteed to be thread safe.
VirtuosoParameter Constructor
VirtuosoParameter Constructor ()
Initializes a new instance of the VirtuosoParameter class.
public VirtuosoParameter();
VirtuosoParameter Constructor (string, object)
Initializes a new instance of the VirtuosoParameter class with the parameter name and value.
public VirtuosoParameter(
string
parameterName
,
object
object
);
Parameters
- parameterName
-
The name of the parameter to map.
- value
-
An Object that is the value of the VirtuosoParameter.
Remarks
When you specify an Object in the value parameter, the VirtDbType is inferred from the .NET Framework type of the Object.
VirtuosoParameter Constructor (string, VirtDbType)
Initializes a new instance of the VirtuosoParameter class with the parameter name and the data type.
public VirtuosoParameter(
string
parameterName
,
VirtDbType
dbType
);
Remarks
The data type, and if appropriate, Size and Precision are inferred from the value of the dbType parameter.
VirtuosoParameter Constructor (string, VirtDbType, int)
Initializes a new instance of the VirtuosoParameter class with the parameter name, the VirtDbType, and the size.
public VirtuosoParameter(
string
parameterName
,
VirtDbType
dbType
,
int
size
);
Parameters
- parameterName
-
The name of the parameter to map.
- dbType
-
One of the VirtDbType values.
- size
-
The width of the parameter.
Remarks
The Size is inferred from the value of the dbType parameter if it is not explicitly set in the size parameter.
VirtuosoParameter Constructor (string, VirtDbType, int, string)
Initializes a new instance of the VirtuosoParameter class with the parameter name, VirtDbType, size, and source column name.
public VirtuosoParameter(
string
parameterName
,
VirtDbType
dbType
,
int
size
,
string
sourceColumn
);
Parameters
- parameterName
-
The name of the parameter to map.
- dbType
-
One of the VirtDbType values.
- size
-
The width of the parameter.
- sourceColumn
-
The name of the source column.
Remarks
The Size is inferred from the value of the dbType parameter if it is not explicitly set in the size parameter.
VirtuosoParameter Constructor (string, VirtDbType, int, ParameterDirection, Boolean, Byte, Byte, String, DataRowVersion, Object)
Initializes a new instance of the VirtuosoParameter class with the parameter name, the type of the parameter, the size of the parameter, a ParameterDirection, the precision of the parameter, the scale of the parameter, the source column, a DataRowVersion to use, and the value of the parameter.
public VirtuosoParameter(
string
parameterName
,
VirtDbType
dbType
,
int
size
,
ParameterDirection
direction
,
bool
isNullable
,
byte
precision
,
byte
scale
,
string
sourceColumn
,
DataRowVersion
sourceVersion
,
object
value
);
Parameters
- parameterName
-
The name of the parameter to map.
- dbType
-
One of the VirtDbType values.
- size
-
The width of the parameter.
- direction
-
One of the System.Data.ParameterDirection values.
- isNullable
-
true
if the value of the field can be null, otherwisefalse
. - precision
-
The total number of digits to the left and right of the decimal point to which Value is resolved.
- scale
-
The total number of decimal places to which Value is resolved.
- sourceColumn
-
The name of the source column.
- sourceVersion
-
One of the System.Data.DataRowVersion values.
- value
-
An Object that is the value of the VirtuosoParameter.
Remarks
The Size and Precision are inferred from the value of the dbType parameter if they are not explicitly set in the size and precision parameters.
Properties
DbType Property
Gets or sets the DbType of the parameter.
public
DbType
DbType
;
Remarks
The VirtDbType and DbType are linked. Therefore, setting the DbType changes the VirtDbType to a supporting VirtDbType.
For a list of the supported data types, see the appropriate VirtDbType member.
Direction Property
Gets or sets a value indicating whether the parameter is input-only, output-only, bidirectional, or a stored procedure return value parameter.
public
ParameterDirection
Direction
;
Remarks
If the ParameterDirection is Output, and execution of the associated VirtuosoCommand does not return a value, the VirtuosoParameter will contain a null value. Null values are handled using the DBNull class. After the last row from the last resultset is read, the Output, InputOut, and ReturnValue parameters are updated.
IsNullable Property
Gets or sets a value indicating whether the parameter accepts null values.
public
bool
IsNullable
;
ParameterName Property
Gets or sets the name of the VirtuosoParameter.
public
string
ParameterName
;
Remarks
Instead of named parameters, the Virtuoso .NET Data Provider uses positional parameters that are marked with a question mark (?) in the syntax of the command text. Parameter objects in the VirtuosoParameterCollection and the actual parameters accepted by the stored procedure or parameterized SQL statement correspond to each other based on the order in which the VirtuosoParameter objects are inserted into the collection rather than by parameter name. Parameter names can be supplied, but will be ignored during parameter object binding.
Precision Property
Gets or sets the maximum number of digits used to represent the Value property.
public
byte
Precision
;
Property Value
The maximum number of digits used to represent the Value property. The default value is 0.
Scale Property
Gets or sets the number of decimal places to which Value is resolved.
public
byte
Scale
;
Size Property
Gets or sets the maximum size, in bytes, of the data within the column.
public
int
Size
;
Property Value
The maximum size, in bytes, of the data within the column. The default value is inferred from the parameter value.
Remarks
The Size property is used for binary and string types.
For variable-length data types, the Size property describes the maximum amount of data to transmit to the server. For example, for a string value, the Size property could be used to limit the amount of data sent to the server to the first one hundred bytes.
For nonstring data types and ANSI string data, the Size property refers to the number of bytes. For Unicode string data, the Size property refers to the number of characters. The count for strings does not include the terminating character.
If not explicitly set, the value of Size is inferred from the actual size of the specified parameter value.
For fixed-width data types, the value of Size is ignored. It can be retrieved for informational purposes, and returns the maximum amount of bytes the provider uses when transmitting the value of the parameter to the server.
SourceColumn Property
Gets or sets the name of the source column mapped to the DataSet and used for loading or returning the Value.
public
string
SourceColumn
;
Property Value
The name of the source column that will be used to set the value of this parameter. The default is an empty string ("").
Remarks
When SourceColumn is set to anything other than an empty string, the value of the parameter is retrieved from the column with the SourceColumn name. If Direction is set to Input, the value is taken from the DataSet. If Direction is set to Output, the value is taken from the data source. A Direction of InputOutput is a combination of both.
SourceVersion Property
Gets or sets the DataRowVersion to use when loading Value.
public
DataRowVersion
DataRowVersion
;
Remarks
The SourceVersion is used by UpdateCommand during an Update operation to determine whether the parameter value is set to Current or Original. This allows primary keys to be updated. This property is ignored by InsertCommand and DeleteCommand.
This property is set to the version of the DataRow used by either the Item property (DataRow indexer), or the GetChildRows method of the DataRow object.
Value Property
Gets or sets the value of the parameter.
public
object
Value
;
Remarks
For input parameters, the value is bound to the VirtuosoCommand that is sent to the server. For output and return-value parameters, the value is set on completion of the VirtuosoCommand and after the VirtuosoDataReader is closed.
When sending a null parameter value to the server, the user must specify DBNull, not null. A null value in the system is an empty object that has no value. DBNull is used to represent null values.
If the application specifies the database type, the bound value is converted to that type when the provider sends the data to the server. The provider attempts to convert any type of value if it supports the IConvertible interface. Conversion errors may result if the specified type is not compatible with the value.
Both the DbType and VirtDbType properties can be inferred by setting Value. If applicable, the size, precision and scale will also be inferred from Value.
The Value property is overwritten by the Update method.
VirtDbType Property
Gets or sets the VirtDbType of the parameter.
public
VirtDbType
VirtDbType
;
Remarks
The VirtDbType and DbType are linked. Therefore, setting the DbType changes the VirtDbType to a supporting VirtDbType.
For a list of the supported data types, see the appropriate VirtDbType member. For more information, see "Using Parameters with a DataAdapter" in the Microsoft® .NET Framework SDK documentation.
VirtuosoParameterCollection Class
Represents a collection of parameters relevant to a VirtuosoCommand as well as their respective mappings to columns in a DataSet. This class cannot be inherited.
System.Object |
System.MarshalByRefObject |
VirtuosoParameterCollection |
public sealed class VirtuosoParameterCollection extends, MarshalByRefObject
implements, IDataParameterCollection , ICollection , IEnumerable , IList {
}
Thread Safety
Any public static (Shared in Visual Basic) members of this type are safe for multithreaded operations. Any instance members are not guaranteed to be thread safe.
Properties
Methods
Add Method
Add Method (object)
Adds the specified VirtuosoParameter object to the VirtuosoParameterCollection.
public int Add(
object
value
);
Add Method (VirtuosoParameter)
Adds the specified VirtuosoParameter object to the VirtuosoParameterCollection.
public VirtuosoParameter Add(
VirtuosoParameter
value
);
Add Method (string, object)
Adds a VirtuosoParameter to the VirtuosoParameterCollection with the specified parameter name and value.
public VirtuosoParameter Add(
string
parameterName
,
object
value
);
Parameters
- parameterName
-
The name of the parameter.
- value
-
The Value of the VirtuosoParameter to add to the collection.
Add Method (string, VirtDbType)
Adds a VirtuosoParameter to the VirtuosoParameterCollection with the specified parameter name and data type.
public VirtuosoParameter Add(
string
parameterName
,
VirtDbType
dbType
);
Add Method (string, VirtDbType, int)
Adds a VirtuosoParameter to the VirtuosoParameterCollection with the specified parameter name, data type, and parameter size.
public VirtuosoParameter Add(
string
parameterName
,
VirtDbType
dbType
,
int
size
);
Parameters
- parameterName
-
The name of the parameter.
- value
-
One of the VirtDbType values.
- size
-
The size of the parameter (width of the column).
Add Method (string, VirtDbType, int, string)
Adds a VirtuosoParameter to the VirtuosoParameterCollection with the specified parameter name, data type, parameter size, and source column name.
public VirtuosoParameter Add(
string
parameterName
,
VirtDbType
dbType
,
int
size
,
string
sourceColumn
);
Parameters
- parameterName
-
The name of the parameter.
- value
-
One of the VirtDbType values.
- size
-
The size of the parameter (width of the column).
- sourceColumn
-
The name of the source column.
Contains Method
Contains Method (object)
Gets a value indicating whether a VirtuosoParameter object exists in the collection.
public bool Contains(
object
value
);
Contains Method (string)
Gets a value indicating whether a VirtuosoParameter object with the specified parameter name exists in the collection.
public bool Contains(
string
parameterName
);
CopyTo Method
Copies VirtuosoParameter objects from the VirtuosoParameterCollection to the specified array.
public void CopyTo(
Array
array
,
int
index
);
Parameters
- array
-
The array into which to copy the VirtuosoParameter objects.
- index
-
The starting index of the array.
GetEnumerator Method
This member supports the Microsoft® .NET Framework infrastructure and is not intended to be used directly from your code.
public IEnumerator GetEnumerator();
IndexOf Method
IndexOf Method (object)
Gets the location in the collection of a VirtuosoParameter object.
public int IndexOf(
object
value
);
IndexOf Method (string)
Gets the location in the collection of the VirtuosoParameter object with the specified parameter name.
public int IndexOf(
string
parameterName
);
Insert Method
Inserts a VirtuosoParameter into the collection at the specified index.
public void Insert(
int
index
,
object
value
);
Parameters
- index
-
The zero-based index where the parameter is to be inserted within the collection.
- value
-
The VirtuosoParameter to add to the collection.
Remove Method
Removes the specified VirtuosoParameter from the collection.
public void Remove(
object
value
);
VirtuosoPermission Class
Provides the capability for the Virtuoso .NET Data Provider to ensure that a user has a security level adequate to access a data source. This class cannot be inherited.
System.Object |
System.Security.CodeAccessPermission |
VirtuosoPermission |
public sealed class VirtuosoPermission extends, CodeAccessPermission
implements, IUnrestrictedPermission {
}
Thread Safety
Any public static (Shared in Visual Basic) members of this type are safe for multithreaded operations. Any instance members are not guaranteed to be thread safe.
VirtuosoPermission Constructor
VirtuosoPermission Constructor ()
Initializes a new instance of the VirtuosoPermission class.
public VirtuosoPermission();
Methods
Copy Method
Creates and returns an identical copy of the current permission object.
public override IPermission Copy();
Remarks
A copy of a permission object represents the same access to resources as the original permission object.
FromXml Method
Reconstructs a security object with a specified state from an XML encoding.
public override void FromXml(
SecurityElement
securityElement
);
Intersect Method
Returns a new permission object representing the intersection of the current permission object and the specified permission object.
public override IPermission Intersect(
IPermission
target
);
Parameters
- target
-
A permission object to intersect with the current permission object. It must be of the same type as the current permission object.
Return Value
A new permission object that represents the intersection of the current permission object and the specified permission object. This new permission object is a null reference (Nothing in Visual Basic) if the intersection is empty.
Remarks
The intersection of two permissions is a permission that describes the set of operations they both describe in common. Only a demand that passes both original permissions will pass the intersection.
IsSubsetOf Method
Returns a value indicating whether the current permission object is a subset of the specified permission object.
public override bool IsSubsetOf(
IPermission
target
);
Parameters
- target
-
A permission object that is to be tested for the subset relationship. This object must be of the same type as the current permission object.
Return Value
true
if the current permission object is a subset of the specified
permission object; otherwise false
.
Remarks
The current permission object is a subset of the specified permission object if the current permission object specifies a set of operations that is wholly contained by the specified permission object. For example, a permission that represents access to C:\example.txt is a subset of a permission that represents access to C:\. If this method returns true, the current permission object represents no more access to the protected resource than does the specified permission object.
IsUnrestricted Method
Returns a value indicating whether the permission can be represented as unrestricted without any knowledge of the permission semantics.
public bool IsUnrestricted();
Return Value
true
if the VirtuosoPermission instance was created with
PermissionState.Unrestricted; otherwise, false
.
ToXml Method
Creates an XML encoding of the security object and its current state.
public override SecurityElement ToXml();
Union Method
Creates a permission that is the union of the permission and the specified permission.
public override IPermission Union(
IPermission
target
);
Parameters
- target
-
A permission to combine with the current permission. It must be of the same type as the current permission.
Return Value
A new permission that represents the union of the current permission and the specified permission.
Remarks
The result of a call to Union is a permission that represents all the operations represented by both the current permission and the specified permission. Any demand that passes either permission passes their union.
VirtuosoPermissionAttribute
Allows security actions for VirtuosoPermission to be applied to code using declarative security. This class cannot be inherited.
System.Object |
System.Attribute |
System.Security.Permissions.SecurityAttribute |
System.Security.Permissions.CodeAccessSecurityAttribute |
VirtuosoPermissionAttribute |
public sealed class VirtuosoPermissionAttribute extends, CodeAccessSecurityAttribute {
}
Thread Safety
Any public static (Shared in Visual Basic) members of this type are safe for multithreaded operations. Any instance members are not guaranteed to be thread safe.
VirtuosoRowUpdatedEventArgs Class
Provides data for the RowUpdated event. This class cannot be inherited.
System.Object |
System.EventArgs |
System.Data.Common.RowUpdatedEventArgs |
VirtuosoRowUpdatedEventArgs |
public sealed class VirtuosoRowUpdatedEventArgs extends, RowUpdatedEventArgs {
}
Thread Safety
Any public static (Shared in Visual Basic) members of this type are safe for multithreaded operations. Any instance members are not guaranteed to be thread safe.
VirtuosoRowUpdatedEventArgs Constructor
Initializes a new instance of the VirtuosoRowUpdatedEventArgs class.
public VirtuosoRowUpdatedEventArgs(
DataRow
row
,
IDbCommand
command
,
StatementType
statementType
,
DataTableMapping
tableMapping
);
Parameters
- row
-
The DataRow sent through an Update.
- command
-
The IDbCommand executed when Update is called.
- statementType
-
One of the StatementType values that specifies the type of query executed.
- tableMapping
-
The DataTableMapping sent through an Update.
VirtuosoRowUpdatedEventHandler Delegate
Represents the method that will handle the RowUpdated event of a VirtuosoDataAdapter.
public delegate void VirtuosoRowUpdatedEventHandler(
object
sender
,
VirtuosoRowUpdatedEventArgs
e
);
Parameters
The declaration of your event handler must have the same parameters as the VirtuosoRowUpdatedEventHandler delegate declaration.
- sender
-
The source of the event.
- e
-
A VirtuosoRowUpdatedEventArgs object that contains the event data.
Remarks
The handler is not required perform any action, and your code should avoid generating exceptions or allowing exceptions to propagate to the calling method. Any exceptions that do reach the caller are ignored. When you create a VirtuosoRowUpdatedEventHandler delegate, you identify the method that will handle the event. To associate the event with your event handler, add an instance of the delegate to the event. The event handler is called whenever the event occurs, unless you remove the delegate. For more information about event handler delegates, see "Events and Delegates" in the .NET Framework SDK documentation.
VirtuosoRowUpdatingEventArgs Class
Provides data for the RowUpdating event. This class cannot be inherited.
System.Object |
System.EventArgs |
System.Data.Common.RowUpdatingEventArgs |
VirtuosoRowUpdatingEventArgs |
public sealed class VirtuosoRowUpdatingEventArgs extends, RowUpdatingEventArgs {
}
Thread Safety
Any public static (Shared in Visual Basic) members of this type are safe for multithreaded operations. Any instance members are not guaranteed to be thread safe.
VirtuosoRowUpdatingEventArgs Constructor
Initializes a new instance of the VirtuosoRowUpdatingEventArgs class.
public VirtuosoRowUpdatingEventArgs(
DataRow
row
,
IDbCommand
command
,
StatementType
statementType
,
DataTableMapping
tableMapping
);
Parameters
- row
-
The DataRow sent through an Update.
- command
-
The IDbCommand executed when Update is called.
- statementType
-
One of the StatementType values that specifies the type of query executed.
- tableMapping
-
The DataTableMapping sent through an Update.
VirtuosoRowUpdatingEventHandler Delegate
Represents the method that will handle the RowUpdating event of a VirtuosoDataAdapter.
public delegate void VirtuosoRowUpdatingEventHandler(
object
sender
,
VirtuosoRowUpdatingEventArgs
e
);
Parameters
The declaration of your event handler must have the same parameters as the VirtuosoRowUpdatingEventHandler delegate declaration.
- sender
-
The source of the event.
- e
-
A VirtuosoRowUpdatingEventArgs object that contains the event data.
Remarks
The handler is not required perform any action, and your code should avoid generating exceptions or allowing exceptions to propagate to the calling method. Any exceptions that do reach the caller are ignored. When you create a VirtuosoRowUpdatingEventHandler delegate, you identify the method that will handle the event. To associate the event with your event handler, add an instance of the delegate to the event. The event handler is called whenever the event occurs, unless you remove the delegate. For more information about event handler delegates, see "Events and Delegates" in the .NET Framework SDK documentation.
VirtuosoTransaction Class
Represents a transaction to be made at a Virtuoso database. This class cannot be inherited.
System.Object |
System.MarshalByRefObject |
VirtuosoTransaction |
public sealed class VirtuosoTransaction extends, MarshalByRefObject
implements, IDbTransaction , IDisposable {
}
Thread Safety
Any public static (Shared in Visual Basic) members of this type are safe for multithreaded operations. Any instance members are not guaranteed to be thread safe.
Remarks
The application creates a VirtuosoTransaction object by calling BeginTransaction on the VirtuosoConnection object. All subsequent operations associated with the transaction (for example, committing or aborting the transaction), are performed on the VirtuosoTransaction object.
Properties
Connection
Gets the VirtuosoConnection object associated with the transaction.
public
VirtuosoConnection
Connection
;
Remarks
A single application may have multiple database connections, each with zero or more transactions. This property enables you to determine the connection object associated with a particular transaction.