虚谷文档 v1.0.0

适用虚谷数据库版本

v12.10.13



适用虚谷数据库版本

v12.10.13


XGConnection类 ​

XGConnection 是与虚谷数据库交互的连接类，所有操作都将从XGConnection开始。XGConnection对象使用连接字符串进行配置，连接字符串包含多个键值对，以分号分隔。在打开连接对象之前需要先配置对象的连接字符串。

构造函数 ​

XGConnection() ​

功能

XGConnection构造函数。

原型

cs
XGConnection([string conn_str])

参数

  • conn_str: 连接字符串(可选)。

返回值

无返回值。

说明

XGConnection 构造函数传入conn_str参数时，会将参数设置到ConnectionString属性上。

示例

cs
XGConnection t_Conn = new XGConnection();
string ConnectionString = "IP=192.168.2.216;PORT=5138;DB=SYSTEM;USER=SYSDBA;PWD=SYSDBA;CHAR_SET=GBK";
XGConnection t_Conn_I = new XGConnection(ConnectionString);

属性 ​

ConnectionString ​

功能

连接串属性，里面是各个连接参数的键值对，连接字符串包含多个键值对，以分号分隔。

说明

键值键值说明
IP服务端的IP地址
IPS多IP创建连接（IP与IP之间使用逗号间隔）
PORT连接的端口信息
DBNAME连接的数据库名
USER连接的用户名
PASSWORD该用户名对应的口令
CHAR_SET应用端使用的字符集
USESSL加密连接（取值为TRUE OR FALSE）

提示

其他数据库会话连接参数，直接使用数据库会话连接参数名传递参数。

示例

cs
XGConnection t_Conn = new XGConnection();
t_Conn.ConnectionString = "IP=192.168.2.216;PORT=5138;DB=SYSTEM;USER=SYSDBA;PWD=SYSDBA;CHAR_SET=GBK;USESSL=TRUE;";

方法 ​

Open() ​

功能

打开XGConnection对象，与数据库创建连接通道实现交互。

原型

cs
void Open()

参数

无参数。

返回值

无返回值。

说明

如果网络不通，或者服务端的连接信息有误，或者服务器关闭，那么此函数会抛出异常。

示例

cs
XGConnection t_Conn = new XGConnection();
t_Conn.ConnectionString = "IP=192.168.2.216;PORT=5138;DB=SYSTEM;USER=SYSDBA;PWD=SYSDBA;CHAR_SET=GBK";
t_Conn.Open();

BeginTransaction() ​

功能

开启数据库事务。

重载

函数原型函数说明
BeginTransaction()开启数据库事务
BeginTransaction(IsolationLevel isolationLevel)使用隔离级别开启数据库事务。
BeginTransaction() ​

功能

开启数据库事务。

原型

cs
public XGTransaction BeginTransaction()

参数

无参数。

返回值

XGTransaction对象。

示例

cs
XGConnection t_Conn = new XGConnection();
t_Conn.ConnectionString = "IP=192.168.2.216;PORT=5138;DB=SYSTEM;USER=SYSDBA;PWD=SYSDBA;CHAR_SET=GBK";
t_Conn.Open();
XGTransaction t_Tran = t_Conn.BeginTransaction();
BeginTransaction(IsolationLevel isolationLevel) ​

功能

开启数据库事务。

原型

cs
public XGTransaction BeginTransaction(IsolationLevel isolationLevel)

参数

  • isolationLevel: 事务隔离级别。

返回值

XGTransaction对象。

示例

cs
XGConnection t_Conn = new XGConnection();
t_Conn.ConnectionString = "IP=192.168.2.216;PORT=5138;DB=SYSTEM;USER=SYSDBA;PWD=SYSDBA;CHAR_SET=GBK";
t_Conn.Open();
XGTransaction t_Tran = t_Conn.BeginTransaction(System.Data.IsolationLevel.ReadUncommitted);

ChangeDatabase() ​

功能

切换连接对象连接的数据库。

原型

cs
public void ChangeDatabase(string databaseName)

参数

  • databaseName：要切换的数据库名

返回值

无返回值。

示例

cs
XGConnection t_Conn = new XGConnection();
t_Conn.ConnectionString = "IP=127.0.0.1;PORT=5138;DB=SYSTEM;USER=SYSDBA;PWD=SYSDBA;CHAR_SET=GBK";
t_Conn.Open();
t_Conn.ChangeDatabase("TEST");

Close() ​

功能

关闭与数据库的连接。

原型

cs
public override void Close();

参数

无参数。

返回值

无返回值。

示例

cs
XGConnection t_Conn = new XGConnection();
t_Conn.ConnectionString = "IP=127.0.0.1;PORT=5138;DB=SYSTEM;USER=SYSDBA;PWD=SYSDBA;CHAR_SET=GBK";
t_Conn.Open();
t_Conn.Close();

CreateCommand() ​

功能

创建并返回与 XGConnection 关联的 XGCommand 对象。

原型

cs
protected override DbCommand CreateDbCommand()

参数

无参数。

返回值

XGCommand对象。

示例

cs
XGConnection t_Conn = new XGConnection();
t_Conn.ConnectionString = "IP=127.0.0.1;PORT=5138;DB=SYSTEM;USER=SYSDBA;PWD=SYSDBA;CHAR_SET=GBK";
t_Conn.Open();
XGCommand t_cmd = t_Conn.CreateCommand();

GetSchema() ​

功能

创建并返回与 XGConnection 关联的 XGCommand 对象。

重载

函数原型函数说明
GetSchema()返回此 SqlConnection 的数据源的架构信息。
GetSchema(String)使用指定架构名称返回此 SqlConnection 数据源的架构信息。
GetSchema(String,String[])使用指定的字符串作为架构名称，使用指定的字符串数组作为限制值，返回此 SqlConnection 的数据源的架构信息。
GetSchema() ​

原型

cs
public override DataTable GetSchema()

参数

无参数。

返回值

包含 Schema 信息的 DataTable 对象。

示例

cs
XGConnection t_Conn = new XGConnection();
t_Conn.ConnectionString = "IP=127.0.0.1;PORT=5138;DB=SYSTEM;USER=SYSDBA;PWD=SYSDBA;CHAR_SET=GBK";
t_Conn.Open();
DataTable t_getschema = t_Conn.GetSchema();
GetSchema() ​

原型

cs
public override DataTable GetSchema(String collectionName)

参数

  • collectionName: 指定要返回的架构的名称。

返回值

包含 Schema 信息的 DataTable 对象。

示例

cs
XGConnection t_Conn = new XGConnection();
t_Conn.ConnectionString = "IP=127.0.0.1;PORT=5138;DB=SYSTEM;USER=SYSDBA;PWD=SYSDBA;CHAR_SET=GBK";
t_Conn.Open();
DataTable t_getschema = t_Conn.GetSchema("TEST");
GetSchema() ​

原型

cs
public override DataTable GetSchema(string collectionName, string[] restrictionValues)

参数

  • collectionName: 指定要返回的架构的名称。

  • restrictionValues: 限制请求架构的一组字符串值。

返回值

包含 Schema 信息的 DataTable 对象。

示例

cs
XGConnection t_Conn = new XGConnection();
t_Conn.ConnectionString = "IP=127.0.0.1;PORT=5138;DB=SYSTEM;USER=SYSDBA;PWD=SYSDBA;CHAR_SET=GBK";
t_Conn.Open();
String[] tableRestrictions = new String[4];
tableRestrictions[2] = "Course";
DataTable t_getschema = t_Conn.GetSchema("TEST",tableRestrictions);

CreateCommand() ​

功能

创建并返回与 XGConnection 关联的 XGCommand 对象。

原型

cs
protected override DbCommand CreateDbCommand()

参数

无参数。

返回值

XGCommand对象。

示例

cs
XGConnection t_Conn = new XGConnection();
t_Conn.ConnectionString = "IP=127.0.0.1;PORT=5138;DB=SYSTEM;USER=SYSDBA;PWD=SYSDBA;CHAR_SET=GBK";
t_Conn.Open();
XGCommand t_cmd = t_Conn.CreateCommand();

XGCommand类 ​

XGCommand 是执行数据库命令的命令类，设置 sql 语句与数据库进行交互，一般可以执行的语句按功能可以分为：查询语句，插入语句，修改语句，删除语句，设定某些属性的语句，执行存储过程或函数的语句等。

构造函数 ​

功能

初始化 XGCommand 类的新对象。

重载

函数原型函数说明
XGCommand()初始化 XGCommand 类的新对象。
XGCommand(string, XGConnection)使用初始SQL 和 XGConnection 对象初始化 XGCommand 类的新对象。

XGCommand() ​

原型

cs
public XGCommand()

参数

无参数。

返回值

无返回值。

示例

cs
XGCommand t_Cmd = new XGCommand();

XGCommand(string, XGConnection) ​

原型

cs
public XGCommand(string cmd_sql, XGConnection conn)

参数

  • cmd_sql：提前设置 XGCommand 对象要执行的SQL语句。

  • conn：绑定 XGCommand 对象所属的 XGConnection 对象。

返回值

XGCommand 对象。

示例

cs
string ConnectionString = "IP=127.0.0.1;PORT=5138;DB=SYSTEM;USER=SYSDBA;PWD=SYSDBA;CHAR_SET=GBK";
XGConnection t_Conn = new XGConnection(ConnectionString);
XGCommand t_Cmd = new XGCommand("SELECT 1 FROM DUAL",t_Conn);

属性 ​

CommandText ​

功能

存储要在数据库中执行的 SQL 语句、表名或存储过程。

说明

当 CommandType 属性设置为 StoredProcedure 时，应将 CommandText 属性设置为存储过程的名称。

示例

cs
XGCommand t_Cmd = new XGCommand();
t_Cmd.CommandText = "select 1 from dual";

CommandType ​

功能

指示如何解释 CommandText 属性。

原型

cs
public override CommandType CommandType;

说明

取值值说明
Text纯文本SQL。
StoredProcedure以存储过程名称解释CommandText。
TableDirect表名。

示例

cs
XGCommand t_Cmd = new XGCommand();
t_Cmd.CommandType = CommandType.Text;
t_Cmd.CommandText = "select 1 from dual";

Connection ​

功能

XGCommand 绑定的 XGConnection 对象。

原型

cs
public XGConnection Connection;

说明

XGCommand 绑定的数据库连接对象。默认值为null。

示例

cs
XGCommand t_Cmd = new XGCommand();
string ConnectionString = "IP=192.168.2.216;PORT=5138;DB=SYSTEM;USER=SYSDBA;PWD=SYSDBA;CHAR_SET=GBK";
XGConnection t_Conn_I = new XGConnection(ConnectionString);
t_Cmd.Connection = t_Conn_I;
t_Conn_I.Open();

Transaction ​

功能

XGCommand 绑定的 XGTransaction 对象。

原型

cs
public XGTransaction Transaction;

说明

XGCommand 绑定的 XGTransaction 对象。默认值为null。

示例

cs
XGCommand t_Cmd = new XGCommand();
XGTransaction t_Tran = new XGTransaction();
t_Cmd.Transaction = t_Tran;

Use_Server_Cursor ​

功能

是否使用服务端游标的开关。

原型

cs
public bool Use_Server_Cursor;

说明

当此属性设置为true时，对select查询数据的语句有效,此时查询的结果集数据将存放于服务端，而不是缓冲在本地。

示例

cs
XGCommand t_Cmd = new XGCommand();
t_Cmd.Use_Server_Cursor = true;

方法 ​

Clone() ​

功能

创建一个新的XGCommand对象，该对象是当前对象的拷贝。

原型

cs
public object Clone()

参数

无参数。

返回值

XGCommand对象。

示例

cs
XGCommand t_Cmd = new XGCommand();
XGCommand t_Cmd_I = t_Cmd.Clone();

CreateParameter() ​

功能

创建一个XGParameters对象。

原型

cs
public new XGParameters CreateParameter()

参数

无参数。

返回值

XGParameters对象。

示例

cs
XGCommand t_Cmd = new XGCommand();
XGParameters t_Param = t_Cmd.CreateParameter();

ExecuteNonQuery() ​

功能

完成SQL语句的执行，并返回受影响的行数。

原型

cs
public override int ExecuteNonQuery()

参数

无参数。

返回值

受影响的行数。

示例

cs
XGConnection t_Conn = new XGConnection();
t_Conn.ConnectionString = "IP=127.0.0.1;PORT=5138;DB=SYSTEM;USER=SYSDBA;PWD=SYSDBA;CHAR_SET=GBK";
t_Conn.Open();
XGCommand t_Cmd = t_Conn.CreateCommand();
t_Cmd.CommandText = "insert into t_test values(1);";
int rownum = t_Cmd.ExecuteNonQuery();

ExecuteReader() ​

功能

执行 CommandText 并构建一个 XGDataReader。

重载

函数原型函数说明
ExecuteReader()执行 CommandText 并构建一个 XGDataReader。
ExecuteReader(CommandBehavior)执行 CommandText 并用 CommandBehavior 之一的值构建一个 XGDataReader。
ExecuteReader() ​

原型

cs
public override int ExecuteReader()

参数

无参数。

返回值

一个 XGDataReader 对象。

示例

cs
XGConnection t_Conn = new XGConnection();
t_Conn.ConnectionString = "IP=127.0.0.1;PORT=5138;DB=SYSTEM;USER=SYSDBA;PWD=SYSDBA;CHAR_SET=GBK";
t_Conn.Open();
XGCommand t_Cmd = t_Conn.CreateCommand();
t_Cmd.CommandText = "select * from all_tables";
var t_data = t_Cmd.ExecuteReader();
ExecuteReader() ​

原型

cs
public override int ExecuteReader(CommandBehavior)

参数

无参数。

返回值

一个 XGDataReader 对象。

示例

cs
XGConnection t_Conn = new XGConnection();
t_Conn.ConnectionString = "IP=127.0.0.1;PORT=5138;DB=SYSTEM;USER=SYSDBA;PWD=SYSDBA;CHAR_SET=GBK";
t_Conn.Open();
XGCommand t_Cmd = t_Conn.CreateCommand();
t_Cmd.CommandText = "select * from all_tables";
var t_data = t_Cmd.ExecuteReader(CommandBehavior.CloseConnection);

ExecuteScalar() ​

功能

执行查询，并返回查询返回的结果集中第一行的第一列。其他列或行将被忽略。

原型

cs
public override object ExecuteScalar()

参数

无参数。

返回值

返回结果集中第一行的第一列，如果结果集为空，则为 null 引用。

示例

cs
XGConnection t_Conn = new XGConnection();
t_Conn.ConnectionString = "IP=127.0.0.1;PORT=5138;DB=SYSTEM;USER=SYSDBA;PWD=SYSDBA;CHAR_SET=GBK";
t_Conn.Open();
XGCommand t_Cmd = t_Conn.CreateCommand();
t_Cmd.CommandText = "select 1 from dual";
var res = t_Cmd.ExecuteScalar();

Prepare() ​

功能

预处理SQL语句。

原型

cs
public override void Prepare();

参数

无参数。

返回值

无返回值。

示例

cs
XGConnection t_Conn = new XGConnection();
t_Conn.ConnectionString = "IP=127.0.0.1;PORT=5138;DB=SYSTEM;USER=SYSDBA;PWD=SYSDBA;CHAR_SET=GBK";
t_Conn.Open();
XGCommand t_Cmd = t_Conn.CreateCommand();
t_Cmd.CommandText = "select 1 from dual";
t_Cmd.Prepare();
var res = t_Cmd.ExecuteScalar();

XGConnectionPool类 ​

XGConnectionPool 类的主要功能是满足大量的短操作的数据库访问行为，包括建立连接、操作数据、关闭连接。

构造函数 ​

XGConnectionPool() ​

功能

初始化 XGConnectionPool 类的新对象。

原型

cs
public XGConnectionPool()

参数

无参数。

返回值

无返回值。

示例

cs
XGConnectionPool t_ConnPool = new XGConnectionPool();

方法 ​

GetConnection() ​

功能

从连接池中获取连接。

原型

cs
public XGConnection GetConnection()

参数

无参数

返回值

XGConnection 对象。

示例

cs
XGConnectionPool t_ConnPool = new XGConnectionPool();
t_ConnPool.SetConnAttribute_IP("127.0.0.1");
t_ConnPool.SetConnAttribute_Port(5138);
t_ConnPool.SetConnAttribute_DataBase("SYSTEM");
t_ConnPool.SetConnAttribute_User("SYSDBA");
t_ConnPool.SetConnAttribute_Password("SYSDBA")
var t_Conn = t_ConnPool.GetConnection();

Return_conntoPool() ​

功能

将连接对象返回到连接池中。

原型

cs
private void Return_conntoPool(XGConnection Conn)

参数

  • Conn：需要返回到连接池中的连接对象。

返回值

无返回值。

示例

cs
XGConnectionPool t_ConnPool = new XGConnectionPool();
t_ConnPool.SetConnAttribute_IP("127.0.0.1");
t_ConnPool.SetConnAttribute_Port(5138);
t_ConnPool.SetConnAttribute_DataBase("SYSTEM");
t_ConnPool.SetConnAttribute_User("SYSDBA");
t_ConnPool.SetConnAttribute_Password("SYSDBA")
var t_Conn = t_ConnPool.GetConnection();
t_ConnPool.Return_conntoPool(t_Conn);

SetConnAttribute_Autocommit() ​

功能

设置连接池中连接的自动提交属性。

原型

cs
public void SetConnAttribute_Autocommit(string autocommit)

参数

  • autocommit：自动提交属性，取值为ON，OFF，表示开启和关闭。

返回值

无返回值。

示例

cs
XGConnectionPool t_ConnPool = new XGConnectionPool();
t_ConnPool.SetConnAttribute_Autocommit("OFF");

SetConnAttribute_charset() ​

功能

设置连接池中连接的客户端字符集属性。

原型

cs
public void SetConnAttribute_charset(string charset)

参数

  • charset：客户端字符集属性，取值为UTF8，GBK。

返回值

无返回值。

示例

cs
XGConnectionPool t_ConnPool = new XGConnectionPool();
t_ConnPool.SetConnAttribute_charset("UTF8");

SetConnAttribute_DataBase() ​

功能

设置连接池中连接的数据库名属性。

原型

cs
public void SetConnAttribute_DataBase(string dbname)

参数

  • dbname：连接的数据库名值。

返回值

无返回值。

示例

cs
XGConnectionPool t_ConnPool = new XGConnectionPool();
t_ConnPool.SetConnAttribute_DataBase("SYSTEM");

SetConnAttribute_IP() ​

功能

设置连接池中连接的IP属性值。

原型

cs
public void SetConnAttribute_IP(string ip_str)

参数

  • ip_str：连接的IP属性值。

返回值

无返回值。

示例

cs
XGConnectionPool t_ConnPool = new XGConnectionPool();
t_ConnPool.SetConnAttribute_IP("127.0.0.1");

SetConnAttribute_MaxPoolconns() ​

功能

设置连接池中最大的连接个数。

原型

cs
public void SetConnAttribute_MaxPoolconns(int maxs)

参数

  • maxs：连接池最大能创建的连接个数属性值。

返回值

无返回值。

示例

cs
XGConnectionPool t_ConnPool = new XGConnectionPool();
t_ConnPool.SetConnAttribute_MaxPoolconns(10);

SetConnAttribute_MinPoolconns() ​

功能

设置连接池中最小的连接个数。

原型

cs
public void SetConnAttribute_MinPoolconns(int maxs)

参数

  • maxs：连接池最小能创建的连接个数属性值。

返回值

无返回值。

示例

cs
XGConnectionPool t_ConnPool = new XGConnectionPool();
t_ConnPool.SetConnAttribute_MinPoolconns(2);

SetConnAttribute_Password() ​

功能

设置连接池中连接的密码属性值。

原型

cs
public void SetConnAttribute_Password(string password)

参数

  • password：连接的密码属性值。

返回值

无返回值。

示例

cs
XGConnectionPool t_ConnPool = new XGConnectionPool();
t_ConnPool.SetConnAttribute_Password("SYSDBA");

SetConnAttribute_Port() ​

功能

设置连接池中连接的端口属性值。

原型

cs
public void SetConnAttribute_Port(int port)

参数

  • port：连接的端口属性值。

返回值

无返回值。

示例

cs
XGConnectionPool t_ConnPool = new XGConnectionPool();
t_ConnPool.SetConnAttribute_Port(5138);

SetConnAttribute_TimeOut() ​

功能

设置连接池中创建连接的超时报错值。

原型

cs
public void SetConnAttribute_TimeOut(int ntime)

参数

  • ntime：连接池中创建连接的超时报错值，单位为秒。

返回值

无返回值。

示例

cs
XGConnectionPool t_ConnPool = new XGConnectionPool();
t_ConnPool.SetConnAttribute_TimeOut(3600);

SetConnAttribute_User() ​

功能

设置连接池中连接的用户名属性值。

原型

cs
public void SetConnAttribute_User(string user)

参数

  • user：连接池中连接的用户名属性值。

返回值

无返回值。

示例

cs
XGConnectionPool t_ConnPool = new XGConnectionPool();
t_ConnPool.SetConnAttribute_User("SYSDBA");

XGConnectionStringBuilder类 ​

构造函数 ​

功能

初始化 XGConnectionStringBuilder 对象。

重载

函数原型函数说明
XGConnectionStringBuilder()初始化 XGConnectionStringBuilder 类的新对象。
XGConnectionStringBuilder(string)使用初始连接字符串 XGConnectionStringBuilder 类的新对象。

XGConnectionStringBuilder() ​

原型

cs
public XGConnectionStringBuilder()

参数

无参数。

返回值

无返回值。

示例

cs
XGConnectionStringBuilder t_ConnBuild = new XGConnectionStringBuilder();

XGConnectionStringBuilder(string) ​

原型

cs
public XGConnectionStringBuilder(string connectionString)

参数

  • connectionString：连接字符串，解析成键值对后赋值到 XGConnectionStringBuilder 类的属性。

返回值

XGConnectionStringBuilder 对象。

示例

cs
string ConnectionString = "IP=127.0.0.1;PORT=5138;DB=SYSTEM;USER=SYSDBA;PWD=SYSDBA;CHAR_SET=GBK";
XGConnectionStringBuilder t_ConnBuild = new XGConnectionStringBuilder(ConnectionString);

属性 ​

ConnectionString ​

功能

XGConnectionStringBuilder 最终产生的连接字符串属性。

原型

cs
public new string ConnectionString;

示例

cs
XGConnectionStringBuilder t_ConnBuild = new XGConnectionStringBuilder();
t_ConnBuild.Add("IP","127.0.0.1");
var connectionstring = t_ConnBuild.ConnectionString;

Count ​

功能

XGConnectionStringBuilder 已存储的键值对组数。

原型

cs
public int Count

示例

cs
XGConnectionStringBuilder t_ConnBuild = new XGConnectionStringBuilder();
t_ConnBuild.Add("IP","127.0.0.1");
var count = t_ConnBuild.Count;

IsFixedSize ​

功能

XGConnectionStringBuilder 是否具有固定大小。

原型

cs
public bool IsFixedSize

示例

cs
XGConnectionStringBuilder t_ConnBuild = new XGConnectionStringBuilder();
var IsFixedSize = t_ConnBuild.IsFixedSize;

IsReadOnly ​

功能

XGConnectionStringBuilder 是否只读。

原型

cs
public bool IsReadOnly

示例

cs
XGConnectionStringBuilder t_ConnBuild = new XGConnectionStringBuilder();
var IsReadOnly = t_ConnBuild.IsReadOnly;

Keys ​

功能

一个 System.Collections.ICollection 内部包含 XGConnectionStringBuilder 中的键。

原型

cs
public ICollection Keys

示例

cs
XGConnectionStringBuilder t_ConnBuild = new XGConnectionStringBuilder();
var Keys = t_ConnBuild.Keys;

Values ​

功能

一个 System.Collections.ICollection 内部包含 XGConnectionStringBuilder 中的值。

原型

cs
public ICollection Values

示例

cs
XGConnectionStringBuilder t_ConnBuild = new XGConnectionStringBuilder();
var Values = t_ConnBuild.Values;

方法 ​

Add() ​

功能

将带有指定键和值的条目添加到 XGConnectionStringBuilder 中。

原型

cs
public new void Add(string keyword, object value)

参数

  • keyword: 待添加的键值。

  • value：待添加的属性值。

返回值

无返回值。

示例

cs
XGConnectionStringBuilder t_ConnBuild = new XGConnectionStringBuilder();
t_ConnBuild.Add("IP","127.0.0.1");

Clear() ​

功能

清空 XGConnectionStringBuilder 已经添加过的键值对属性。

原型

cs
public override void Clear()

参数

无参数

返回值

无返回值。

示例

cs
XGConnectionStringBuilder t_ConnBuild = new XGConnectionStringBuilder();
t_ConnBuild.Add("IP","127.0.0.1");
t_ConnBuild.Clear();

ContainsKey() ​

功能

确定 XGConnectionStringBuilder 是否包含特定键值的键值对。

原型

cs
public override bool ContainsKey(string keyword)

参数

  • keyword：待检索的键值。

返回值

包含具有指定键的项，则为 true；否则为 false。

示例

cs
XGConnectionStringBuilder t_ConnBuild = new XGConnectionStringBuilder();
t_ConnBuild.Add("IP","127.0.0.1");
t_ConnBuild.ContainsKey("IP");

EquivalentTo() ​

功能

将此 XGConnectionStringBuilder 对象中的连接信息与 XGConnectionStringBuilder 对象中的连接信息进行比较。

原型

cs
public override bool EquivalentTo(XGConnectionStringBuilder connectionStringBuilder)

参数

  • connectionStringBuilder：要与此 XGConnectionStringBuilder 对象进行比较的 XGConnectionStringBuilder。

返回值

如果两个 XGConnectionStringBuilder 对象中的连接信息生成等效的连接字符串，则为 true；否则false。

示例

cs
XGConnectionStringBuilder t_ConnBuild = new XGConnectionStringBuilder();
XGConnectionStringBuilder t_ConnBuild_II = new XGConnectionStringBuilder();
t_ConnBuild.Add("IP","127.0.0.1");
t_ConnBuild.EquivalentTo(t_ConnBuild_II);

GetProperties() ​

功能

用有关 Hashtable 的所有属性的信息，填充 XGConnectionStringBuilder 。

原型

cs
protected override void GetProperties(Hashtable propertyDescriptors)

参数

  • propertyDescriptors：使用有关此 Hashtable 的信息填充 XGConnectionStringBuilder 。

返回值

无返回值。

示例

cs
XGConnectionStringBuilder t_ConnBuild = new XGConnectionStringBuilder();
var 
var hastable = new Hashtable();
t_ConnBuild.GetProperties(hastable);

Remove() ​

功能

从 XGConnectionStringBuilder 示例移除具有指定的键的项。

原型

cs
public override bool Remove(string keyword)

参数

  • keyword：要移除的键/值对中的键。

返回值

如果该键存在于连接字符串中并已被移除，则为 true；如果该键不存在，则为 false。

示例

cs
XGConnectionStringBuilder t_ConnBuild = new XGConnectionStringBuilder();
t_ConnBuild.Add("IP","127.0.0.1");
t_ConnBuild.Remove("IP");

ShouldSerialize() ​

功能

确定 XGConnectionStringBuilder 是否包含特定键值的键值对。

原型

cs
public override bool ShouldSerialize(string keyword)

说明

此方法的行为与 ContainsKey 方法完全相同。

参数

  • keyword：待检索的键值。

返回值

包含具有指定键的项，则为 true；否则为 false。

示例

cs
XGConnectionStringBuilder t_ConnBuild = new XGConnectionStringBuilder();
t_ConnBuild.Add("IP","127.0.0.1");
t_ConnBuild.ShouldSerialize("IP");

ToString() ​

功能

返回与此 XGConnectionStringBuilder 关联的连接字符串。

原型

cs
public override string ToString()

参数

无参数。

返回值

当前 XGConnectionStringBuilder.ConnectionString 属性。

示例

cs
XGConnectionStringBuilder t_ConnBuild = new XGConnectionStringBuilder();
t_ConnBuild.Add("IP","127.0.0.1");
t_ConnBuild.ToString();

TryGetValue() ​

功能

从此 XGConnectionStringBuilder 中检索与提供的键相对应的值。

原型

cs
public override bool TryGetValue(string keyword, out object value)

参数

  • keyword：要检索的项的键。

  • value：与 key 对应的值。

返回值

如果在连接字符串中找到 keyword，则为 true，否则为 false。

示例

cs
XGConnectionStringBuilder t_ConnBuild = new XGConnectionStringBuilder();
t_ConnBuild.Add("IP","127.0.0.1");
object value;
t_ConnBuild.TryGetValue("IP",out value);

XGDataAdapter 类 ​

构造函数 ​

功能

XGDataAdapter 类初始化函数。

重载

函数原型函数说明
XGDataAdapter()初始化 XGDataAdapter 类的新对象。
XGDataAdapter(XGCommand)使用指定的 XGCommand 作为 SelectCommand 属性初始化 SqlDataAdapter 类的新对象。
XGDataAdapter(string,XGConnect)使用 SelectCommand 和 XGConnection 对象初始化 SqlDataAdapter 类的新对象。
XGDataAdapter(string,string)使用 SelectCommand 和连接字符串初始化 SqlDataAdapter 类的新对象。

XGDataAdapter() ​

原型

cs
public XGDataAdapter()

参数

无参数。

返回值

无返回值。

示例

cs
var t_DataAdapter  = new XGDataAdapter();

XGDataAdapter(XGCommand) ​

原型

cs
public XGDataAdapter(XGCommand selectCommand)

参数

  • selectCommand: 指定的 XGCommand 。

返回值

无返回值。

示例

cs
XGCommand t_Cmd = new XGCommand();
t_Cmd.CommandText = "SELECT 1 FROM DUAL";
var t_DataAdapter  = new XGDataAdapter(t_Cmd);

XGDataAdapter(string, XGConnection) ​

原型

cs
public XGDataAdapter(string selectCommandText, XGConnection selectConnection)

参数

  • selectCommandText: SELECT 语句 作为 SelectCommand 属性值 。

  • selectConnection：表示连接的 XGConnection。

返回值

无返回值。

示例

cs
XGConnection t_Conn = new XGConnection();
var t_DataAdapter  = new XGDataAdapter("SELECT 1 FROM DUAL",t_Conn);

XGDataAdapter(string, string) ​

原型

cs
public XGDataAdapter(string selectCommandText, string selectConnectionString)

参数

  • selectCommandText: SELECT 语句 作为 SelectCommand 属性值 。

  • selectConnectionString: 连接字符串，用于内部 XGConnection 对象创建连接。

返回值

无返回值。

示例

cs
XGConnection t_Conn = new XGConnection();
var t_DataAdapter  = new XGDataAdapter("SELECT 1 FROM DUAL","IP=192.168.2.216;PORT=5138;DB=SYSTEM;USER=SYSDBA;PWD=SYSDBA;CHAR_SET=GBK");

属性 ​

DeleteCommand ​

功能

在 Update（DataSet） 期间使用的 XGCommand，用于删除数据库中与 DataSet 中已删除的行相对应的记录。

原型

cs
public new XGCommand DeleteCommand

示例

cs
string ConnectionString = "IP=192.168.2.216;PORT=5138;DB=SYSTEM;USER=SYSDBA;PWD=SYSDBA;";
XGConnection t_Conn = new XGConnection(ConnectionString);
t_Conn.Open()
XGDataAdapter t_Adapter = new XGDataAdapter();
XGCommand t_Cmd = new XGCommand("DELETE TEST;", t_Conn);
t_Adapter.DeleteCommand = t_Cmd;

InsertCommand ​

功能

在 Update（DataSet） 期间使用的 XGCommand，用于插入数据库中与 DataSet 中已新增的行相对应的记录。

原型

cs
public new XGCommand InsertCommand

示例

cs
string ConnectionString = "IP=192.168.2.216;PORT=5138;DB=SYSTEM;USER=SYSDBA;PWD=SYSDBA;";
XGConnection t_Conn = new XGConnection(ConnectionString);
t_Conn.Open()
XGDataAdapter t_Adapter = new XGDataAdapter();
XGCommand t_Cmd = new XGCommand("INSERT INTO TEST(ID) VALUES(1);", t_Conn);
t_Adapter.InsertCommand = t_Cmd;

SelectCommand ​

功能

在 Fill（DataSet） 期间使用的 XGCommand，用于从数据库中选择要放置在 DataSet 中的记录。

原型

cs
public new XGCommand SelectCommand

示例

cs
string ConnectionString = "IP=192.168.2.216;PORT=5138;DB=SYSTEM;USER=SYSDBA;PWD=SYSDBA;";
XGConnection t_Conn = new XGConnection(ConnectionString);
t_Conn.Open()
XGCommand t_Cmd = new XGCommand("SELECT * FROM TEST;", t_Conn);
XGDataAdapter t_Adapter = new XGDataAdapter();
t_Adapter.SelectCommand = t_Cmd;

UpdateCommand ​

功能

在 Update（DataSet） 期间使用的 XGCommand，用于修改数据库中与 DataSet 中已修改的行相对应的记录。

原型

cs
public new XGCommand UpdateCommand

示例

cs
string ConnectionString = "IP=192.168.2.216;PORT=5138;DB=SYSTEM;USER=SYSDBA;PWD=SYSDBA;";
XGConnection t_Conn = new XGConnection(ConnectionString);
t_Conn.Open()
XGDataAdapter t_Adapter = new XGDataAdapter();
XGCommand t_Cmd = new XGCommand("UPDATE TEST SET ID = 10 WHERE ID = 1;", t_Conn);
t_Adapter.UpdateCommand = t_Cmd;

UpdateCommand ​

功能

在 Update（DataSet） 期间使用的 XGCommand，用于修改数据库中与 DataSet 中已修改的行相对应的记录。

原型

cs
public new XGCommand UpdateCommand

示例

cs
string ConnectionString = "IP=192.168.2.216;PORT=5138;DB=SYSTEM;USER=SYSDBA;PWD=SYSDBA;";
XGConnection t_Conn = new XGConnection(ConnectionString);
t_Conn.Open()
XGDataAdapter t_Adapter = new XGDataAdapter();
XGCommand t_Cmd = new XGCommand("UPDATE TEST SET ID = 10 WHERE ID = 1;", t_Conn);
t_Adapter.UpdateCommand = t_Cmd;

方法 ​

Fill() ​

功能

将数据从数据库中检索出来填充到一个内存中的离线数据容器中。

重载

函数原型函数说明
Fill(DataSet)将数据从数据库中检索出来填充到 DataSet 对象中。
Fill(DataTable)将数据从数据库中检索出来填充到 DataTable 对象中。
Fill(DataSet,string)将数据从数据库中检索出来填充到的 DataSet 对象中指定的表下。
Fill(DataSet) ​

功能

将数据从数据库中检索出来填充到 DataSet 对象中。

原型

cs
public new int Fill(DataSet dataSet)

参数

  • dataSet：待填充的 DataSet 对象。

返回值

成功添加或刷新的行数。

示例

cs
string ConnectionString = "IP=192.168.2.216;PORT=5138;DB=SYSTEM;USER=SYSDBA;PWD=SYSDBA;";
XGConnection t_Conn = new XGConnection(ConnectionString);
t_Conn.Open()
XGCommand t_Cmd = new XGCommand("SELECT * FROM TEST;", t_Conn);
XGDataAdapter t_Adapter = new XGDataAdapter();
t_Adapter.SelectCommand = t_Cmd;
var dataset = new DataSet();
t_Adapter.Fill(dataset);
Fill(DataTable) ​

功能

将数据从数据库中检索出来填充到 DataTable 对象中。

原型

cs
public new int Fill(DataTable dataTable)

参数

  • dataTable：待填充的 DataTable 对象。

返回值

成功添加或刷新的行数。

示例

cs
string ConnectionString = "IP=192.168.2.216;PORT=5138;DB=SYSTEM;USER=SYSDBA;PWD=SYSDBA;";
XGConnection t_Conn = new XGConnection(ConnectionString);
t_Conn.Open()
XGCommand t_Cmd = new XGCommand("SELECT * FROM TEST;", t_Conn);
XGDataAdapter t_Adapter = new XGDataAdapter();
t_Adapter.SelectCommand = t_Cmd;
var datatable = new DataTable();
t_Adapter.Fill(datatable);
Fill(DataSet,string) ​

功能

将数据从数据库中检索出来填充到的 DataSet 对象中指定的表下。

原型

cs
public new int Update(DataSet dataSet, string srcTable)

参数

  • dataSet ：待填充的 DataSet 对象。

  • srcTable : DataSet 对象指定的表名。

返回值

成功添加或刷新的行数。

示例

cs
string ConnectionString = "IP=192.168.2.216;PORT=5138;DB=SYSTEM;USER=SYSDBA;PWD=SYSDBA;";
XGConnection t_Conn = new XGConnection(ConnectionString);
t_Conn.Open()
XGCommand t_Cmd = new XGCommand("SELECT * FROM TEST;", t_Conn);
XGDataAdapter t_Adapter = new XGDataAdapter();
t_Adapter.SelectCommand = t_Cmd;
var dataSet = new DataSet();
t_Adapter.Fill(dataSet,"TEST");

Update() ​

功能

将内存中 DataSet 或 DataTable 的更改（插入、更新、删除）推送回底层数据库。

重载

函数原型函数说明
Update(DataSet)将 DataSet 对象中的变更推送到数据库中。
Update(DataTable)将 DataTable 对象中的变更推送到数据库中。
Update(DataSet,string)将 DataSet 对象中指定表的变更推送到数据库中。
Update(DataSet) ​

功能

将 DataSet 对象中的变更推送到数据库中。

原型

cs
public new int Update(DataSet dataSet)

参数

  • dataSet：待推送的 DataSet 对象。

返回值

成功更新的行数。

示例

cs
string ConnectionString = "IP=192.168.2.216;PORT=5138;DB=SYSTEM;USER=SYSDBA;PWD=SYSDBA;";
XGConnection t_Conn = new XGConnection(ConnectionString);
t_Conn.Open()
XGCommand t_Cmd = new XGCommand("SELECT * FROM TEST;", t_Conn);
XGDataAdapter t_Adapter = new XGDataAdapter();
t_Adapter.SelectCommand = t_Cmd;
var dataset = new DataSet();
t_Adapter.Fill(dataset);
t_Adapter.Update(dataset);
Update(DataTable) ​

功能

将 DataTable 对象中的变更推送到数据库中。

原型

cs
public new int Update(DataTable datatable)

参数

  • datatable ：待推送的 DataTable 对象。

返回值

成功更新的行数。

示例

cs
string ConnectionString = "IP=192.168.2.216;PORT=5138;DB=SYSTEM;USER=SYSDBA;PWD=SYSDBA;";
XGConnection t_Conn = new XGConnection(ConnectionString);
t_Conn.Open()
XGCommand t_Cmd = new XGCommand("SELECT * FROM TEST;", t_Conn);
XGDataAdapter t_Adapter = new XGDataAdapter();
t_Adapter.SelectCommand = t_Cmd;
var datatable = new DataTable();
t_Adapter.Fill(datatable);
t_Adapter.Update(datatable);
Update(DataSet,string) ​

功能

将 DataSet 对象中的指定表名的变更推送到数据库中。

原型

cs
public new int Update(DataSet dataSet, string srcTable)

参数

  • dataSet ：待推送的 DataSet 对象。

  • srcTable : DataSet 指定的表名。

返回值

成功更新的行数。

示例

cs
string ConnectionString = "IP=192.168.2.216;PORT=5138;DB=SYSTEM;USER=SYSDBA;PWD=SYSDBA;";
XGConnection t_Conn = new XGConnection(ConnectionString);
t_Conn.Open()
XGCommand t_Cmd = new XGCommand("SELECT * FROM TEST;", t_Conn);
XGDataAdapter t_Adapter = new XGDataAdapter();
t_Adapter.SelectCommand = t_Cmd;
var dataset = new DataSet();
t_Adapter.Fill(dataset);
t_Adapter.Update(dataset,"TEST");

XGDataReader 类 ​

提供一种从数据库中读取只进行流的方法。

构造函数 ​

功能

初始化 XGDataReader 对象。

原型

cs
public XGDataReader()

参数

无参数。

返回值

无返回值。

示例

cs
var datareader = new XGDataReader();

属性 ​

Depth ​

功能

指示当前行的嵌套深度。

原型

cs
public override int Depth

FieldCount ​

功能

指示当前行中的列数。

原型

cs
public override int FieldCount

HasRows ​

功能

指示此 XGDataReader是否包含一个或多个行。

原型

cs
public override bool HasRows

IsClosed ​

功能

指示 XGDataReader 是否已关闭。

原型

cs
public override bool IsClosed

RecordsAffected ​

功能

指示执行 SQL 语句获取更改、插入或删除的行数。

原型

cs
public override int RecordsAffected

方法 ​

Close() ​

功能

关闭 XGDataReader 对象。

原型

cs
public override void Close()

参数

无参数。

返回值

无返回值。

示例

cs
XGConnection t_Conn = new XGConnection();
t_Conn.ConnectionString = "IP=127.0.0.1;PORT=5138;DB=SYSTEM;USER=SYSDBA;PWD=SYSDBA;CHAR_SET=GBK";
t_Conn.Open();
XGCommand t_Cmd = t_Conn.CreateCommand();
t_Cmd.CommandText = "select * from TEST";
XGDataReader t_data = t_Cmd.ExecuteReader();
t_data.Close();

GetBoolean() ​

功能

将指定列的值作为布尔值获取。

原型

cs
public override bool GetBoolean(int i)

参数

  • i : 从 0 开始的列序号。

返回值

列的值。

说明

不执行任何转换。因此，检索到的数据必须已经是布尔值，否则会生成异常。

GetByte() ​

功能

将指定列的值作为字节获取。

原型

cs
public override byte GetByte(int i)

参数

  • i : 从 0 开始的列序号。

返回值

列的值。

说明

不执行任何转换。因此，检索到的数据必须已经是一个字节，否则会生成异常。

GetBytes() ​

功能

将字节流从指定的列偏移量读取到缓冲区中，该数组从给定的缓冲区偏移量开始。

原型

cs
public override long GetBytes(int i, long dataIndex, byte[] buffer, int bufferIndex, int length)

参数

  • i : 从 0 开始的列序号。

  • dataIndex : 读取的数据的偏移位置。

  • buffer : 接收数据的缓存区。

  • bufferIndex : 缓存区写入位置的索引。

  • length : 要复制到缓存区的最大长度。

返回值

读取的实际字节数。

说明

GetBytes 返回字段中的可用字节数。大多数情况下，这是字段的确切长度。但是，如果已使用 GetBytes 从字段获取字节，则返回的数字可能小于字段的真实长度。

不执行任何转换。因此，检索到的数据必须已经是一个字节，否则会生成异常。

GetChar() ​

功能

将指定列的值作为单个字符获取。

原型

cs
public override char GetChar(int i)

参数

  • i : 从 0 开始的列序号。

返回值

列的值。

说明

不执行任何转换。因此，检索到的数据必须已经是一个字符，否则会生成异常。

GetChars() ​

功能

将指定列的值作为单个字符获取。

原型

cs
public override long GetChars(int i, long dataIndex, char[] buffer, int bufferIndex, int length)

参数

  • i : 从 0 开始的列序号。

  • dataIndex : 读取的数据的偏移位置。

  • buffer : 接收数据的缓存区。

  • bufferIndex : 缓存区写入位置的索引。

  • length : 要复制到缓存区的最大长度。

返回值

读取的实际字符数。

说明

GetChars 返回 字段中的可用字符数。 通常，这是字段的确切长度。 但是，如果 GetChars 已用于从字段获取字符，则返回的数字可能小于字段的真实长度。

不执行任何转换。因此，检索到的数据必须已经是一个字符，否则会生成异常。

GetDataTypeName() ​

功能

获取指定列的数据类型的名称。

原型

cs
public override string GetDataTypeName(int i)

参数

  • i : 从 0 开始的列序号。

返回值

指定列的数据类型的名称。

说明

数据类型名称为数据库中类型名称。

GetDate() ​

功能

获取指定列的值作为 DateTime 对象。

原型

cs
public DateTime GetDate(int i)

参数

  • i : 从 0 开始的列序号。

返回值

列的值。

说明

不执行任何转换。因此，检索到的数据必须已经是一个 DateTime 对象，否则会生成异常。

在调用此方法之前，调用 IsDBNull（Int32） 以检查 null 值。

GetDateTime() ​

功能

获取指定列的值作为 DateTime 对象。

原型

cs
public DateTime GetDateTime(int i)

参数

  • i : 从 0 开始的列序号。

返回值

列的值。

说明

不执行任何转换。因此，检索到的数据必须已经是一个 DateTime 对象，否则会生成异常。

在调用此方法之前，调用 IsDBNull（Int32） 以检查 null 值。

GetDecimal() ​

功能

获取指定列的值作为 Decimal 对象。

原型

cs
public override decimal GetDecimal(int i)

参数

  • i : 从 0 开始的列序号。

返回值

列的值。

说明

不执行任何转换。因此，检索到的数据必须已经是一个 Decimal 对象，否则会生成异常。

在调用此方法之前，调用 IsDBNull（Int32） 以检查 null 值。

GetDouble() ​

功能

获取指定列的值作为 double 对象。

原型

cs
public override double GetDouble(int i)

参数

  • i : 从 0 开始的列序号。

返回值

列的值。

说明

不执行任何转换。因此，检索到的数据必须已经是一个 double 对象，否则会生成异常。

在调用此方法之前，调用 IsDBNull（Int32） 以检查 null 值。

GetEnumerator() ​

功能

返回一个循环访问 XGDataReader 的 IEnumerator。

原型

cs
public override IEnumerator GetEnumerator()

参数

无参数。

返回值

一个 System.Collections.IEnumerator，可用于循环访问数据读取器中的行。

说明

直接使用循环构造（foreach）以便循环访问数据读取器中的行会更简单。

GetFieldType() ​

功能

获取指定列的数据类型。

原型

cs
public override Type GetFieldType(int i)

参数

  • i : 从 0 开始的列序号。

返回值

指定列的数据类型。

说明

该值为 CSharp 数据类型。

GetFloat() ​

功能

获取指定列的值作为 float 对象。

原型

cs
public override float GetFloat(int i)

参数

  • i : 从 0 开始的列序号。

返回值

列的值。

说明

不执行任何转换。因此，检索到的数据必须已经是一个 float 对象，否则会生成异常。

在调用此方法之前，调用 IsDBNull（Int32） 以检查 null 值。

GetGuid() ​

功能

获取指定列的值作为 guid 对象。

原型

cs
public override Guid GetGuid(int i)

参数

  • i : 从 0 开始的列序号。

返回值

列的值。

说明

不执行任何转换。因此，检索到的数据必须已经是一个 guid 对象，否则会生成异常。

在调用此方法之前，调用 IsDBNull（Int32） 以检查 null 值。

GetInt16() ​

功能

获取指定列的值作为 short 对象。

原型

cs
public override short GetInt16(int i)

参数

  • i : 从 0 开始的列序号。

返回值

列的值。

说明

不执行任何转换。因此，检索到的数据必须已经是一个 short 对象，否则会生成异常。

在调用此方法之前，调用 IsDBNull（Int32） 以检查 null 值。

GetInt32() ​

功能

获取指定列的值作为 int 对象。

原型

cs
public override int GetInt32(int i)

参数

  • i : 从 0 开始的列序号。

返回值

列的值。

说明

不执行任何转换。因此，检索到的数据必须已经是一个 int 对象，否则会生成异常。

在调用此方法之前，调用 IsDBNull（Int32） 以检查 null 值。

GetInt64() ​

功能

获取指定列的值作为 long 对象。

原型

cs
public override long GetInt64(int i)

参数

  • i : 从 0 开始的列序号。

返回值

列的值。

说明

不执行任何转换。因此，检索到的数据必须已经是一个 long 对象，否则会生成异常。

在调用此方法之前，调用 IsDBNull（Int32） 以检查 null 值。

GetName() ​

功能

获取指定列的列名。

原型

cs
public override string GetName(int i)

参数

  • i : 从 0 开始的列序号。

返回值

指定列的列名。

GetOrdinal() ​

功能

获取指定列名的列序号。

原型

cs
public override int GetOrdinal(string name)

参数

  • name : 指定的列名。

返回值

指定列的从 0 开始的列序号。

说明

列名不存在的时候会抛出异常。

GetSchemaTable() ​

功能

返回一个 System.Data.DataTable，它描述 System.Data.Common.DbDataReader 的列元数据。

原型

cs
public override DataTable GetSchemaTable()

参数

无参数。

返回值

一个 System.Data.DataTable，它描述 System.Data.Common.DbDataReader 的列元数据。

GetString() ​

功能

获取指定列的值作为 string 对象。

原型

cs
public override string GetString(int i)

参数

  • i : 从 0 开始的列序号。

返回值

列的值。

说明

不执行任何转换。因此，检索到的数据必须已经是一个 string 对象，否则会生成异常。

在调用此方法之前，调用 IsDBNull（Int32） 以检查 null 值。

GetTableName() ​

功能

获取表名。

原型

cs
public string GetTableName()

参数

无参数。

返回值

返回表名。

GetTimeSpan() ​

功能

获取指定列的值作为 TimeSpan 对象。

原型

cs
public TimeSpan GetTimeSpan(int i)

参数

  • i : 从 0 开始的列序号。

返回值

列的值。

说明

不执行任何转换。因此，检索到的数据必须已经是一个 TimeSpan 对象，否则会生成异常。

在调用此方法之前，调用 IsDBNull（Int32） 以检查 null 值。

GetValue() ​

功能

获取指定列的作为 System.Object 的对象的值。

原型

cs
public override object GetValue(int i)

参数

  • i : 从 0 开始的列序号。

返回值

object。

GetValues() ​

功能

使用当前行的列值来填充对象数组。

原型

cs
public override int GetValues(object[] values)

参数

  • values : 要将列复制到其中的 System.Object 数组。

返回值

复制的列数。

GetXGBlob() ​

功能

获取指定列的作为 XGBlob 的对象的值。

原型

cs
public XGBlob GetXGBlob(int i)

参数

  • i : 从 0 开始的列序号。

返回值

列的值。

GetXGClob() ​

功能

获取指定列的作为 XGClob 的对象的值。

原型

cs
public XGClob GetXGClob(int i)

参数

  • i : 从 0 开始的列序号。

返回值

列的值。

IsDBNull() ​

功能

指示列中是否包含不存在的或已丢失的值。

原型

cs
public override bool IsDBNull(int i)

参数

  • i : 从 0 开始的列序号。

返回值

如果指定的列与 System.DBNull 等效，则为 true；否则为 false。

NextResult() ​

功能

读取批处理 SQL 语句的结果时，使 XGDataReader 前进到下一个结果。

原型

cs
public override bool NextResult()

参数

无参数。

返回值

如果存在下一结果集，且成功切换则为 true；否则为 false。

Read() ​

功能

使 XGDataReader 前进到下一条记录。

原型

cs
public override bool Read()

参数

无参数。

返回值

如果存在下一行数据，且成功前进则为 true；否则为 false。

XGDataRecord 类 ​

用于提取结果集当前行的数据。

构造函数 ​

功能

初始化 XGDataRecord 对象。

原型

cs
public XGDataRecord(XGDataReader  reader)

参数

  • reader : 数据访问类 XGDataReader 对象。

返回值

无返回值。

示例

cs
XGConnection t_Conn = new XGConnection();
t_Conn.ConnectionString = "IP=127.0.0.1;PORT=5138;DB=SYSTEM;USER=SYSDBA;PWD=SYSDBA;CHAR_SET=GBK";
t_Conn.Open();
XGCommand t_Cmd = t_Conn.CreateCommand();
t_Cmd.CommandText = "SELECT * FROM TEST";
var t_data = t_Cmd.ExecuteReader();
var t_recore = new XGDataRecord(t_data);

属性 ​

FieldCount ​

功能

指示当前行中的列数。

原型

cs
public override int FieldCount

方法 ​

GetBoolean() ​

功能

将指定列的值作为布尔值获取。

原型

cs
public override bool GetBoolean(int i)

参数

  • i : 从 0 开始的列序号。

返回值

列的值。

说明

不执行任何转换。因此，检索到的数据必须已经是布尔值，否则会生成异常。

GetByte() ​

功能

将指定列的值作为字节获取。

原型

cs
public override byte GetByte(int i)

参数

  • i : 从 0 开始的列序号。

返回值

列的值。

说明

不执行任何转换。因此，检索到的数据必须已经是一个字节，否则会生成异常。

GetBytes() ​

功能

将字节流从指定的列偏移量读取到缓冲区中，该数组从给定的缓冲区偏移量开始。

原型

cs
public override long GetBytes(int i, long dataIndex, byte[] buffer, int bufferIndex, int length)

参数

  • i : 从 0 开始的列序号。

  • dataIndex : 读取的数据的偏移位置。

  • buffer : 接收数据的缓存区。

  • bufferIndex : 缓存区写入位置的索引。

  • length : 要复制到缓存区的最大长度。

返回值

读取的实际字节数。

说明

GetBytes 返回字段中的可用字节数。大多数情况下，这是字段的确切长度。但是，如果已使用 GetBytes 从字段获取字节，则返回的数字可能小于字段的真实长度。

不执行任何转换。因此，检索到的数据必须已经是一个字节，否则会生成异常。

GetChar() ​

功能

将指定列的值作为单个字符获取。

原型

cs
public override char GetChar(int i)

参数

  • i : 从 0 开始的列序号。

返回值

列的值。

说明

不执行任何转换。因此，检索到的数据必须已经是一个字符，否则会生成异常。

GetChars() ​

功能

将指定列的值作为单个字符获取。

原型

cs
public override long GetChars(int i, long dataIndex, char[] buffer, int bufferIndex, int length)

参数

  • i : 从 0 开始的列序号。

  • dataIndex : 读取的数据的偏移位置。

  • buffer : 接收数据的缓存区。

  • bufferIndex : 缓存区写入位置的索引。

  • length : 要复制到缓存区的最大长度。

返回值

读取的实际字符数。

说明

GetChars 返回 字段中的可用字符数。 通常，这是字段的确切长度。 但是，如果 GetChars 已用于从字段获取字符，则返回的数字可能小于字段的真实长度。

不执行任何转换。因此，检索到的数据必须已经是一个字符，否则会生成异常。

GetDataTypeName() ​

功能

获取指定列的数据类型的名称。

原型

cs
public override string GetDataTypeName(int i)

参数

  • i : 从 0 开始的列序号。

返回值

指定列的数据类型的名称。

说明

数据类型名称为数据库中类型名称。

GetDateTime() ​

功能

获取指定列的值作为 DateTime 对象。

原型

cs
public DateTime GetDateTime(int i)

参数

  • i : 从 0 开始的列序号。

返回值

列的值。

说明

不执行任何转换。因此，检索到的数据必须已经是一个 DateTime 对象，否则会生成异常。

在调用此方法之前，调用 IsDBNull（Int32） 以检查 null 值。

GetDecimal() ​

功能

获取指定列的值作为 Decimal 对象。

原型

cs
public override decimal GetDecimal(int i)

参数

  • i : 从 0 开始的列序号。

返回值

列的值。

说明

不执行任何转换。因此，检索到的数据必须已经是一个 Decimal 对象，否则会生成异常。

在调用此方法之前，调用 IsDBNull（Int32） 以检查 null 值。

GetDouble() ​

功能

获取指定列的值作为 double 对象。

原型

cs
public override double GetDouble(int i)

参数

  • i : 从 0 开始的列序号。

返回值

列的值。

说明

不执行任何转换。因此，检索到的数据必须已经是一个 double 对象，否则会生成异常。

在调用此方法之前，调用 IsDBNull（Int32） 以检查 null 值。

GetFieldType() ​

功能

获取指定列的数据类型。

原型

cs
public override Type GetFieldType(int i)

参数

  • i : 从 0 开始的列序号。

返回值

指定列的数据类型。

说明

该值为 CSharp 数据类型。

GetFloat() ​

功能

获取指定列的值作为 float 对象。

原型

cs
public override float GetFloat(int i)

参数

  • i : 从 0 开始的列序号。

返回值

列的值。

说明

不执行任何转换。因此，检索到的数据必须已经是一个 float 对象，否则会生成异常。

在调用此方法之前，调用 IsDBNull（Int32） 以检查 null 值。

GetGuid() ​

功能

获取指定列的值作为 guid 对象。

原型

cs
public override Guid GetGuid(int i)

参数

  • i : 从 0 开始的列序号。

返回值

列的值。

说明

不执行任何转换。因此，检索到的数据必须已经是一个 guid 对象，否则会生成异常。

在调用此方法之前，调用 IsDBNull（Int32） 以检查 null 值。

GetInt16() ​

功能

获取指定列的值作为 short 对象。

原型

cs
public override short GetInt16(int i)

参数

  • i : 从 0 开始的列序号。

返回值

列的值。

说明

不执行任何转换。因此，检索到的数据必须已经是一个 short 对象，否则会生成异常。

在调用此方法之前，调用 IsDBNull（Int32） 以检查 null 值。

GetInt32() ​

功能

获取指定列的值作为 int 对象。

原型

cs
public override int GetInt32(int i)

参数

  • i : 从 0 开始的列序号。

返回值

列的值。

说明

不执行任何转换。因此，检索到的数据必须已经是一个 int 对象，否则会生成异常。

在调用此方法之前，调用 IsDBNull（Int32） 以检查 null 值。

GetInt64() ​

功能

获取指定列的值作为 long 对象。

原型

cs
public override long GetInt64(int i)

参数

  • i : 从 0 开始的列序号。

返回值

列的值。

说明

不执行任何转换。因此，检索到的数据必须已经是一个 long 对象，否则会生成异常。

在调用此方法之前，调用 IsDBNull（Int32） 以检查 null 值。

GetName() ​

功能

获取指定列的列名。

原型

cs
public override string GetName(int i)

参数

  • i : 从 0 开始的列序号。

返回值

指定列的列名。

GetOrdinal() ​

功能

获取指定列名的列序号。

原型

cs
public override int GetOrdinal(string name)

参数

  • name : 指定的列名。

返回值

指定列的从 0 开始的列序号。

说明

列名不存在的时候会抛出异常。

GetString() ​

功能

获取指定列的值作为 string 对象。

原型

cs
public override string GetString(int i)

参数

  • i : 从 0 开始的列序号。

返回值

列的值。

说明

不执行任何转换。因此，检索到的数据必须已经是一个 string 对象，否则会生成异常。

在调用此方法之前，调用 IsDBNull（Int32） 以检查 null 值。

GetValue() ​

功能

获取指定列的作为 System.Object 的对象的值。

原型

cs
public override object GetValue(int i)

参数

  • i : 从 0 开始的列序号。

返回值

object。

GetValues() ​

功能

使用当前行的列值来填充对象数组。

原型

cs
public override int GetValues(object[] values)

参数

  • values : 要将列复制到其中的 System.Object 数组。

返回值

复制的列数。

IsDBNull() ​

功能

指示列中是否包含不存在的或已丢失的值。

原型

cs
public override bool IsDBNull(int i)

参数

  • i : 从 0 开始的列序号。

返回值

如果指定的列与 System.DBNull 等效，则为 true；否则为 false。

XGParameters 类 ​

存储 XGCommand 对象的参数集元素。

构造函数 ​

功能

初始化 XGParameters 对象。

重载

函数原型函数说明
XGParameters()初始化 XGParameters 对象。
XGParameters(string, object)通过参数名和参数值初始化 XGParameters 对象。
XGParameters(string,XGDbType,int,ParameterDirection,bool,byte,byte,string,DataRowVersion,object)使用参数名称、参数类型、参数大小、ParameterDirection、参数精度、参数小数位数、源列、要使用的 DataRowVersion 和参数值初始化 XGParameter 类的新对象。
XGParameters(string,XGDbType,int)使用参数名称、XGDbType 和大小初始化 XGParameter 类的新对象。
XGParameters(string,XGDbType)使用参数名称、XGDbType 初始化 XGParameter 类的新对象。
XGParameters(XGParameters)拷贝构造函数

XGDbType 具体取值查看 XGDbType 取值 。

XGParameters() ​

功能

初始化 XGParameters 对象。

原型

cs
public XGParameters()

参数

无参数。

返回值

无返回值。

XGParameters(string, object) ​

功能

通过参数名和参数值初始化 XGParameters 对象。

原型

cs
public XGParameters(string name, object value)

参数

  • name : 参数名称。

  • value : 参数值。

返回值

无返回值。

XGParameters(string,XGDbType,int,ParameterDirection,bool,byte,byte,string,DataRowVersion,object) ​

功能

使用参数名称、参数类型、参数大小、ParameterDirection、参数精度、参数小数位数、源列、要使用的 DataRowVersion 和参数值初始化 XGParameter 类的新对象。

原型

cs
public XGParameters(string name, XGDbType xgDbType, int size, ParameterDirection parameterDirection, bool isNullable, byte precision, byte scale, string srcColumn, DataRowVersion srcVersion, object value)

参数

  • name : 参数名称。

  • xgDbType : 虚谷数据库的类型。

  • size : 参数值所占字节大小。

  • parameterDirection : 参数的方向：Input，Output，InputOutput或ReturnValue。

提示

其余参数暂无实际意义，为重写构造函数占位。

返回值

无返回值。

XGParameters(string, XGDbType, int) ​

功能

使用参数名称、XGDbType 和大小初始化 XGParameter 类的新对象。

原型

cs
public XGParameters(string name, XGDbType xgDbType, int size)

参数

  • name : 参数名称。

  • xgDbType : 虚谷数据库的类型。

  • size : 参数值所占字节大小。

返回值

无返回值。

XGParameters(string, XGDbType) ​

功能

使用参数名称、XGDbType 初始化 XGParameter 类的新对象。

原型

cs
public XGParameters(string name, XGDbType xgDbType)

参数

  • name : 参数名称。

  • xgDbType : 虚谷数据库的类型。

返回值

无返回值。

XGParameters(XGParameters) ​

功能

使用 XGParameters 对象 初始化 XGParameter 类的新对象。

原型

cs
public XGParameters(XGParameters param)

参数

  • param :源 XGParameters 对象。

返回值

无返回值。

属性 ​

DbType ​

功能

获取或设置参数的 System.Data.DbType。

原型

cs
public override DbType DbType

说明

设置 DbType 会自动修改成更加支持的XGDbType。

Direction ​

功能

该值指示参数是只可输入、只可输出、双向还是存储过程返回值参数。

原型

cs
public override ParameterDirection Direction

说明

该属性有效值为 System.Data.ParameterDirection 值之一。

IsNullable ​

功能

指示参数是否接受空值。

原型

cs
public override bool IsNullable

说明

如果接受 null 值，则为 true；否则为 false。 默认值为 false。

ParameterName ​

功能

参数名称。

原型

cs
public override string ParameterName

Size ​

功能

参数数据的最大大小（以字节为单位）。

原型

cs
public override int Size

Value ​

功能

参数的值。

原型

cs
public override object Value

方法 ​

Clone() ​

功能

克隆 XGParameters 对象。

原型

cs
public object Clone()

参数

无参数。

返回值

XGParameters 对象。

XGProviderFactory 类 ​

提供一种标准化的工厂模式，用于创建与虚谷数据库交互的 ADO.NET 对象。

构造函数 ​

功能

初始化 XGProviderFactory 对象。

重载

函数原型函数说明
XGProviderFactory()初始化 XGProviderFactory 对象
XGProviderFactory(XGConnection)使用 XGConnection 对象初始化 XGProviderFactory 对象

XGProviderFactory() ​

功能

初始化 XGProviderFactory 对象

原型

cs
public XGProviderFactory()

参数

无参数。

返回值

无返回值。

XGProviderFactory(XGConnection) ​

功能

使用 XGConnection 对象初始化 XGProviderFactory 对象

原型

cs
public XGProviderFactory(XGConnection conn)

参数

无参数。

返回值

无返回值。

属性 ​

Instance ​

功能

静态只读的单例对象，提供全局唯一的工厂对象。

原型

cs
public static readonly XGProviderFactory Instance

说明

确保整个应用程序中只有一个工厂对象（单例模式），避免重复创建对象造成的资源浪费。通过 static readonly 保证线程安全初始化。

方法 ​

CreateCommand() ​

功能

创建 XGCommand 对象。

原型

cs
public override DbCommand CreateCommand()

参数

无参数。

返回值

XGCommand 对象。

CreateCommandBuilder() ​

功能

创建 XGCommandBuilder 对象。

原型

cs
public override DbCommandBuilder CreateCommandBuilder()

参数

无参数。

返回值

XGCommandBuilder 新对象。

CreateConnection() ​

功能

创建 XGConnection 对象。

原型

cs
public override DbConnection CreateConnection()

参数

无参数。

返回值

XGConnection 新对象。

CreateConnectionStringBuilder() ​

功能

创建 XGConnectionStringBuilder 对象。

原型

cs
public override DbConnectionStringBuilder CreateConnectionStringBuilder()

参数

无参数。

返回值

XGConnectionStringBuilder 新对象。

CreateDataAdapter() ​

功能

创建 XGDataAdapter 对象。

原型

cs
public override DbDataAdapter CreateDataAdapter()

参数

无参数。

返回值

XGDataAdapter 新对象。

CreateParameter() ​

功能

创建 XGParameters 对象。

原型

cs
public override DbParameter CreateParameter()

参数

无参数。

返回值

XGParameters 新对象。

XGTransaction 类 ​

构造函数 ​

功能

初始化 XGTransaction 新示对象。

重载

函数原型函数说明
XGTransaction()初始化 XGTransaction 新对象。
XGTransaction(IsolationLevel)以事务提交级别初始化 XGTransaction 新对象。
XGTransaction(XGConnection,IsolationLevel)以 XGConnection 对象和事务提交级别初始化 XGTransaction 新对象。
XGTransaction(XGConnection)以 XGConnection 对象初始化 XGTransaction 新对象。

XGTransaction() ​

功能

初始化 XGTransaction 对象。

原型

cs
public XGTransaction()

参数

无参数。

返回值

无返回值。

XGTransaction(IsolationLevel) ​

功能

以事务提交级别初始化 XGTransaction 新对象。

原型

cs
public XGTransaction(IsolationLevel level)

参数

无参数。

返回值

无返回值。

XGTransaction(XGConnection ,IsolationLevel ) ​

功能

以 XGConnection 对象和事务提交级别初始化 XGTransaction 新对象。

原型

cs
public XGTransaction(XGConnection Conn,IsolationLevel level)

参数

无参数。

返回值

无返回值。

XGTransaction(XGConnection) ​

功能

以 XGConnection 对象初始化 XGTransaction 新对象。

原型

cs
public XGTransaction(XGConnection Conn)

参数

无参数。

返回值

无返回值。

属性 ​

Connection ​

功能

事务所属的 XGConnection 对象。

原型

cs
public new XGConnection Connection

说明

只提供 get 方法获取对象，不允许手动设置。

IsolationLevel ​

功能

事务的提交级别值。

原型

cs
public override IsolationLevel IsolationLevel

说明

只提供 get 方法获取对象，不允许手动设置。

方法 ​

Commit ​

功能

提交当前事务。

原型

cs
public override void Commit()

参数

无参数。

返回值

无返回值。

Rollback ​

功能

回滚当前事务。

原型

cs
public override void Rollback()

参数

无参数。

返回值

无返回值。