ASP.NET接口

1.安装Visual Studio 2019

微软官网下载并安装Visual Studio 2019

2.新建Web网站

打开Visual Studio 2019，在搜索框中输入asp，选择如下选项。
配置项目信息，单击新建。
创建空项目。

3.添加库类

显示所有文件，单击小红框内的按钮。
拷贝Nuxsql.dll和Mono.Security.dll

将Nuxsql.dll和Mono.Security.dll拷贝到项目的bin目录文件夹下。
添加库文件

在项目中，右键“Bin”=>“添加”=>“现有项”，选择Nuxsql.dll和Mono.Security.dll，单击添加。
添加引用

在项目中，右键单击“引用”=>“添加应用”=>浏览选中Nuxsql.dll和Mono.Security.dll，单击确定。

4.添加UXDB.cs接口类

新增App_Code

右键“项目名称”，选择“添加”=>“添加APS.NET”=>“App_Code”。
新建UXDB.cs

App_Code下新建UXDB.cs，右键“App_Code”=>“添加”=>“添加新项”=>选择Visual C#的类=>修改文件名UXDB.cs，单击添加。

添加UXDB.cs的代码，如下所示。

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
//using System.Windows.Forms;
using System.Data;
using Nuxsql;
public class UXDB
{
    DataSet DS;
    bool ECode;
    string ErrString;
    NuxsqlConnection Conn = new NuxsqlConnection();
    public UXDB(string ServerName, string ServerPort, string DBName, string UserName, string Pwd)
    {
        ECode = false;
        Conn.ConnectionString = "Server=" + ServerName + ";Port=" + ServerPort + ";User Id=" + UserName + ";Password=" + Pwd + ";Database=" + DBName;
        try
        {
            Conn.Open();
        }
        catch (Exception e)
        {
            ECode = true;
            ErrString = e.Message;
        }
    }
    public DataSet GetRecordSet(string sql)
    {
        NuxsqlCommand sqlCmd = new NuxsqlCommand();
        sqlCmd.Connection = Conn;
        sqlCmd.CommandText = sql;
        try
        {
            NuxsqlDataAdapter adp = new NuxsqlDataAdapter(sqlCmd);
            DS = new DataSet();
            adp.Fill(DS);
        }
        catch (Exception e)
        {
            ErrString = e.Message;
            ECode = true;
            return null;
        }
        return DS;
    }
    public int ExecuteSQLScalar(string Sqls)
    {
        string s;
        NuxsqlCommand sqlCmd = new NuxsqlCommand();
        sqlCmd.Connection = Conn;
        sqlCmd.CommandText = Sqls;
        sqlCmd.CommandType = CommandType.Text;
        try
        {
            s = sqlCmd.ExecuteScalar().ToString();
        }
        catch (Exception e)
        {
            ErrString = e.Message;
            ECode = true;
            return -1;
        }
        return (int.Parse(s));
    }
    public string ExecuteSQLScalarTOstring(string Sqls)
    {
        string s;
        NuxsqlCommand sqlCmd = new NuxsqlCommand();
        sqlCmd.Connection = Conn;
        sqlCmd.CommandText = Sqls;
        sqlCmd.CommandType = CommandType.Text;
        try
        {
            s = sqlCmd.ExecuteScalar().ToString();
        }
        catch (Exception e)
        {
            ErrString = e.Message;
            ECode = true;
            return "-1";
        }
        return s;
    }
    public string ExecuteSQLWithTrans(string Sqls)
    {
        string s;
        NuxsqlTransaction myTrans;
        myTrans = Conn.BeginTransaction();
        NuxsqlCommand sqlCmd = new NuxsqlCommand();
        sqlCmd.Connection = Conn;
        sqlCmd.CommandText = Sqls;
        sqlCmd.CommandType = CommandType.Text;
        sqlCmd.Transaction = myTrans;
        sqlCmd.ExecuteNonQuery();
        //Sqls="SELECT @@IDENTITY AS ID";  
        sqlCmd.CommandText = Sqls;
        try
        {
            s = sqlCmd.ExecuteScalar().ToString();
        }
        catch (Exception e)
        {
            ErrString = e.Message;
            ECode = true;
            myTrans.Commit();
            return "";
        }
        myTrans.Commit();
        return (s);
    }
    public void ExecuteSQL(string Sqls)
    {
        NuxsqlCommand sqlCmd = new NuxsqlCommand();
        sqlCmd.Connection = Conn;
        sqlCmd.CommandText = Sqls;
        sqlCmd.CommandType = CommandType.Text;
        try
        {
            sqlCmd.ExecuteNonQuery();
        }
        catch (Exception e)
        {
            ErrString = e.Message;
            ECode = true;
        }
    }
    public NuxsqlDataReader DBDataReader(string Sqls)
    {
        NuxsqlCommand sqlCmd = new NuxsqlCommand();
        sqlCmd.Connection = Conn;
        sqlCmd.CommandText = Sqls;
        sqlCmd.CommandType = CommandType.Text;
        try
        {
            return sqlCmd.ExecuteReader(CommandBehavior.CloseConnection);
        }
        catch (Exception e)
        {
            ErrString = e.Message;
            ECode = true;
            return null;
        }
    }
    public void DBClose()
    {
        try
        {
            Conn.Close();
        }
        catch (Exception e)
        {
            ErrString = e.Message;
            ECode = true;
        }
    }
    public bool ErrorCode()
    {
        return ECode;
    }
    public string ErrMessage()
    {
        return ErrString;
    }
    ~UXDB()
    {
    }
}

5.创建窗体

新建Default.aspx

右键“项目名称”，“添加”=>“添加新项”=>“Visual C#”=>“Web窗体”，单击添加。

注意文件名必须为Default.aspx，在后面的编译过程中类名和文件名必须保持一致。

Default.aspx文件中添加测试代码

Default.aspx.cs代码如下所示。

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using Nuxsql;
public partial class Default : System.Web.UI.Page
{
    protected void Page_Load(object sender, EventArgs e)
    {
        //added by qinglong.ou
        //NuxDB myDb = new NuxDB("localhost", "5432", "postgres", "postgres", "123456");
        UXDB myDb = new UXDB("192.168.1.82", "5432", "test", "uxdb", "123456");
        string retStr = "";
        string testSql = "select * from student";
        NuxsqlDataReader reader = myDb.DBDataReader(testSql);
        // 判断数据是否读到尾. 
        while (reader.Read())
        {
            //控制台输入 
            //string temp = String.Format("{0},{1},{2},{3},{4}", reader[0], reader[1], reader[2], reader[3], reader[4]);
            string temp = String.Format("{0},{1},{2},{3}", reader[0], reader[1], reader[2], reader[3]);
            //retStr += temp + "<>";
            retStr += temp + "\n";
        }
        System.Diagnostics.Debug.WriteLine("student\n" + retStr);
        Console.WriteLine(retStr);
        // 一定要关闭 reader 对象. 
        reader.Close();
    }
}

6.运行结果

右键“项目名称”=>“生成网站”，启动调试，查看即时窗口输出。

运行结果如下显示时asp.net连接使用uxdb成功，显示student表的数据与uxdb数据库中查看结果一致。

7.使用分析说明

创建uxdb端的student表。

create table student(
        sno int primary key not null,
        sname varchar(20),
        sage int,
        ssex varchar(6)
    );
    begin;
    insert into student values(1001,'张三',15,'女');
    insert into student values(1002,'李四',16,'男');
    insert into student values(1003,'王五',15,'男');
    insert into student values(1004,'赵六',14,'女');
    insert into student values(1005,'马七',16,'男');
    commit;

UXDB myDb = new UXDB("IP", "port", "db", "user","key")，uxdb-server所在机器IP为192.168.1.82，端口port为52025，所连接db为test，用户user为uxdb，密码为123456。

commit;


UXDB myDb = new UXDB("IP", "port", "db", "user","key")，uxdb-server所在机器IP为`192.168.1.82`，端口port为`52025`，所连接db为`test`，用户user为`uxdb`，密码为`******`。



## 8.接口介绍**


### 8.1.NuxsqlConnection（连接对象，对应 DbConnection）

#### 8.1.1.Notice

- 功能
  
  当收到来自 UXDB 后端的 NoticeResponse 时触发。

- 函数
  
  ```csharp
  NoticeEventHandler Notice

参数：无。
返回值：无。

8.1.2.Notification

功能

当收到来自 UXDB 后端的 NotificationResponse 时触发。
函数
```
NotificationEventHandler Notification
```
参数：无。
返回值：无。

8.1.3.ProvideClientCertificatesCallback

功能

用于为 SSL 握手提供客户端证书。

函数

ProvideClientCertificatesCallback ProvideClientCertificatesCallback

参数：无。
返回值：无。

8.1.4.CertificateSelectionCallback

功能

Mono.Security.Protocol.Tls.CertificateSelectionCallback 委托。

函数

CertificateSelectionCallback CertificateSelectionCallback

参数：无。
返回值：无。

8.1.5.CertificateValidationCallback

功能

Mono.Security.Protocol.Tls.CertificateValidationCallback 委托。

函数

CertificateValidationCallback CertificateValidationCallback

参数：无。
返回值：无。

8.1.6.PrivateKeySelectionCallback

功能

Mono.Security.Protocol.Tls.PrivateKeySelectionCallback 委托。

函数

PrivateKeySelectionCallback PrivateKeySelectionCallback

参数：无。
返回值：无。

8.1.7.ValidateRemoteCertificateCallback

功能

在 SSL 握手期间用于校验服务器证书。

函数

ValidateRemoteCertificateCallback ValidateRemoteCertificateCallback

参数：无。
返回值：无。

8.1.8.NuxsqlConnection

功能

初始化 NuxsqlConnection 类的新实例。
函数
```
NuxsqlConnection()
```
参数：无。
返回值

返回一个 NuxsqlConnection 对象。

8.1.9.NuxsqlConnection

功能

初始化 NuxsqlConnection 类的新实例并设置 ConnectionString。

函数

NuxsqlConnection(String ConnectionString)

参数

表 NuxsqlConnection 参数说明

名称描述

ConnectionString（输入）用于打开 UXDB 数据库的连接。
返回值

返回一个 NuxsqlConnection 对象。

名称	描述
ConnectionString（输入）	用于打开 UXDB 数据库的连接。

8.1.10.NuxsqlConnection

功能

初始化 NuxsqlConnection 类的新实例并设置 ConnectionString。

函数

NuxsqlConnection(NuxsqlConnectionStringBuilder ConnectionString)

参数

表 NuxsqlConnection 参数说明

名称描述

ConnectionString（输入）用于打开 UXDB 数据库的连接。
返回值

返回一个 NuxsqlConnection 对象。

名称	描述
ConnectionString（输入）	用于打开 UXDB 数据库的连接。

8.1.11.ConnectionString

功能

获取或设置用于连接 UXDB 数据库的字符串。有效值如下：Server：UXDB 服务器的地址/名称；Port：连接的端口；Protocol：使用的协议版本（取整数 2 或 3），而非自动选择；Database：数据库名，未指定时默认为用户名；User Id：用户名；Password：明文认证用的密码；SSL：True 或 False，控制是否尝试安全连接，默认 False；Pooling：True 或 False，控制是否使用连接池，默认 True；MinPoolSize：连接池最小大小；MaxPoolSize：连接池最大大小；Timeout：等待连接打开的秒数，默认 15；CommandTimeout：等待命令执行完成、抛出异常前的秒数，默认 20；Sslmode：SSL 连接控制模式，可取 Prefer、Require、Allow 或 Disable，默认 Disable，各值含义参见用户手册；ConnectionLifeTime：关闭池中未使用连接前等待的秒数，默认 15；SyncNotification：指定 Nuxsql 是否使用同步通知；SearchPath：将搜索路径更改为指定的模式和 public 模式。
函数
```
String ConnectionString
```
参数：无。
返回值

返回/设置连接字符串。

8.1.12.Host

功能

后端服务器主机名。
函数
```
String Host
```
参数：无。
返回值

返回主机名。

8.1.13.Port

功能

后端服务器端口。
函数
```
Int32 Port
```
参数：无。
返回值

返回端口号。

8.1.14.SSL

功能

若为 true，连接将尝试使用 SSL。
函数
```
Boolean SSL
```
参数：无。
返回值

返回/设置是否启用 SSL。

8.1.15.UseSslStream

功能

若为 true，连接将尝试使用 SslStream，而非内部的 TlsClientStream。
函数
```
Boolean UseSslStream
```
参数：无。
返回值

返回/设置是否使用 SslStream。

8.1.16.ConnectionTimeout

功能

获取在尝试建立连接时，终止尝试并生成错误前的等待时间。
函数
```
Int32 ConnectionTimeout
```
参数：无。
返回值

返回/设置连接超时时间。

8.1.17.CommandTimeout

功能

获取在尝试执行命令时，终止尝试并生成错误前的等待时间。
函数
```
Int32 CommandTimeout
```
参数：无。
返回值

返回/设置命令超时时间。

8.1.18.ConnectionLifeTime

功能

获取在所有连接数超过 MinPoolSize 时，关闭池中未使用连接前等待的时间。
函数
```
Int32 ConnectionLifeTime
```
参数：无。
返回值

返回/设置连接存活时长。

8.1.19.Database

功能

获取当前数据库的名称，或连接打开后要使用的数据库名称。
函数
```
String Database
```
参数：无。
返回值

返回/设置数据库名。

8.1.20.PreloadReader

功能

是否整体加载数据读取器（为兼容早期代码）。
函数
```
bool PreloadReader
```
参数：无。
返回值

返回/设置是否预加载读取器。

8.1.21.DataSource

功能

获取数据库服务器名称。
函数
```
string DataSource
```
参数：无。
返回值

返回/设置数据源。

8.1.22.SyncNotification

功能

获取指示是否使用同步通知的标志。默认值为 false。
函数
```
Boolean SyncNotification
```
参数：无。
返回值

返回/设置是否使用同步通知。

8.1.23.FullState

功能

获取连接的当前状态。
函数
```
ConnectionState FullState
```
参数：无。
返回值

返回/设置完整连接状态。

8.1.24.State

功能

获取连接当前状态是 Open 还是 Closed。
函数
```
ConnectionState State
```
参数：无。
返回值

返回/设置连接状态。

8.1.25.NuxsqlCompatibilityVersion

功能

兼容性版本。
函数
```
Version NuxsqlCompatibilityVersion
```
参数：无。
返回值

返回/设置UXDB 兼容版本。

8.1.26.ServerVersion

功能

UXDB 服务器版本。
函数
```
string ServerVersion
```
参数：无。
返回值

返回/设置服务端版本号。

8.1.27.BackendProtocolVersion

功能

正在使用的协议版本。仅在存在活动连接时可调用。始终返回 Version3。
函数
```
ProtocolVersion BackendProtocolVersion
```
参数：无。
返回值

返回/设置后端协议版本。

8.1.28.ProcessID

功能

后端服务器的进程 ID。仅在存在活动连接时可调用。
函数
```
Int32 ProcessID
```
参数：无。
返回值

返回/设置后端进程 ID。

8.1.29.UseConformantStrings

功能

报告后端是否要求符合标准的字符串。
函数
```
Boolean UseConformantStrings
```
参数：无。
返回值

返回/设置是否使用符合规范的字符串。

8.1.30.Supports_E_StringPrefix

功能

报告后端是否支持字符串字面量 E 前缀（>= 8.1）。
函数
```
Boolean Supports_E_StringPrefix
```
参数：无。
返回值

返回/设置是否支持 E 字符串前缀。

8.1.31.SupportsHexByteFormat

功能

报告后端是否支持十六进制字节格式（>= 9.0）。
函数
```
Boolean SupportsHexByteFormat
```
参数：无。
返回值

返回/设置是否支持十六进制字节格式。

8.1.32.BeginTransaction

功能

开始一个数据库事务。
函数
```
NuxsqlTransaction BeginTransaction()
```
参数：无。
返回值

表示新事务的 NuxsqlTransaction 对象。

8.1.33.BeginTransaction

功能

以指定的隔离级别开始一个数据库事务。

函数

NuxsqlTransaction BeginTransaction(IsolationLevel level)

参数

表 BeginTransaction 参数说明

名称描述

level（输入）事务运行所使用的隔离级别。
返回值

表示新事务的 NuxsqlTransaction 对象。

名称	描述
level（输入）	事务运行所使用的隔离级别。

8.1.34.Open

功能

按 ConnectionString 指定的属性设置打开数据库连接。
函数
```
void Open()
```
参数：无。
返回值

无返回值。

8.1.35.ChangeDatabase

功能

该方法通过断开当前数据库连接并连接到指定数据库来更改当前数据库。
函数
```
void ChangeDatabase(String dbName)
```
参数

表 ChangeDatabase 参数说明

名称描述

dbName（输入）替代当前数据库使用的数据库名称。
返回值

无返回值。

名称	描述
dbName（输入）	替代当前数据库使用的数据库名称。

8.1.36.Close

功能

释放到数据库的连接。若连接来自连接池，它将被置为可重用；若未使用连接池，则实际连接将被关闭。
函数
```
void Close()
```
参数：无。
返回值

无返回值。

8.1.37.CreateCommand

功能

创建并返回与该 NuxsqlConnection 关联的 NuxsqlCommand 对象。
函数
```
NuxsqlCommand CreateCommand()
```
参数：无。
返回值

一个 NuxsqlCommand 对象。

8.1.38.Clone

功能

基于当前连接创建一个新的连接。
函数
```
NuxsqlConnection Clone()
```
参数：无。
返回值

一个新的 NuxsqlConnection 对象。

8.1.39.UseExtendedTypes

功能

使用扩展类型。
函数
```
bool UseExtendedTypes
```
参数：无。
返回值

返回/设置是否启用扩展类型。

8.1.40.GetSchema

功能

返回受支持的集合。
函数
```
DataTable GetSchema()
```
参数：无。
返回值

返回数据源架构信息表。

8.1.41.GetSchema

功能

返回由集合名指定的架构集合。

函数

DataTable GetSchema(string collectionName)

参数

表 GetSchema 参数说明

名称描述

collectionName（输入）集合名称。
返回值

指定的集合。

8.1.42.GetSchema

功能

返回由集合名指定、并经限制条件筛选后的架构集合。

函数

DataTable GetSchema(string collectionName, string[] restrictions)

参数

表 GetSchema 参数说明

名称	描述
collectionName（输入）	集合名称。
restrictions（输入）	用于筛选结果的限制值；限制条件的说明包含在 Restrictions 集合中。

返回值

指定的集合。

8.1.43.ClearPool

功能

清空连接池。
函数
```
void ClearPool()
```
参数：无。
返回值

无返回值。

8.1.44.ClearAllPools

功能

清空所有连接池。
函数
```
void ClearAllPools()
```
参数：无。
返回值

无返回值。

8.1.45.EnlistTransaction

功能

登记事务。

函数

void EnlistTransaction(Transaction transaction)

参数

表 EnlistTransaction 参数说明

名称描述

transaction（输入）要登记的分布式事务对象。
返回值

无返回值。

名称	描述
transaction（输入）	要登记的分布式事务对象。

8.2.NuxsqlCommand（命令对象，对应 DbCommand）

8.2.1.ExecuteNonQuery

功能

针对该连接执行 SQL 语句，并返回受影响的行数。
函数
```
Int32 ExecuteNonQuery()
```
参数：无。
返回值

受影响的行数（若已知）；否则为 -1。

8.2.2.ExecuteReader

功能

将 CommandText 发送到 Connection 并构建 NuxsqlDataReader。
函数
```
NuxsqlDataReader ExecuteReader()
```
参数：无。
返回值

一个 NuxsqlDataReader 对象。

8.2.3.ExecuteReader

功能

将 CommandText 发送到 Connection，并使用某个 CommandBehavior 值构建 NuxsqlDataReader。

函数

NuxsqlDataReader ExecuteReader(CommandBehavior cb)

参数

表 ExecuteReader 参数说明

名称描述

cb（输入） CommandBehavior 枚举值之一。
返回值

一个 NuxsqlDataReader 对象。

名称	描述
cb（输入）	CommandBehavior 枚举值之一。

8.2.4.ExecuteScalar

功能

执行查询，并返回查询结果集中第一行的第一列。多余的列或行将被忽略。
函数
```
Object ExecuteScalar()
```
参数：无。
返回值

结果集中第一行的第一列；若结果集为空则为 null 引用。

8.2.5.Prepare

功能

在 UXDB 服务器上创建该命令的预编译版本。
函数
```
void Prepare()
```
参数：无。
返回值

无返回值。

8.2.6.NuxsqlCommand

功能

初始化 NuxsqlCommand 类的新实例。
函数
```
NuxsqlCommand()
```
参数：无。
返回值

返回一个 NuxsqlCommand 对象。

8.2.7.NuxsqlCommand

功能

使用查询文本初始化 NuxsqlCommand 类的新实例。
函数
```
NuxsqlCommand(String cmdText)
```
参数

表 NuxsqlCommand 参数说明

名称描述

cmdText（输入）查询的文本。
返回值

返回一个 NuxsqlCommand 对象。

8.2.8.NuxsqlCommand

功能

使用查询文本和一个 NuxsqlConnection 初始化 NuxsqlCommand 类的新实例。

函数

NuxsqlCommand(String cmdText, NuxsqlConnection connection)

参数

表 NuxsqlCommand 参数说明

名称描述

cmdText（输入）查询的文本。

connection（输入）表示一个到 UXDB 服务器连接的 NuxsqlConnection 对象。
返回值

返回一个 NuxsqlCommand 对象。

8.2.9.NuxsqlCommand

功能

使用查询文本、一个 NuxsqlConnection 和 NuxsqlTransaction 初始化 NuxsqlCommand 类的新实例。

函数

NuxsqlCommand(String cmdText, NuxsqlConnection connection, NuxsqlTransaction transaction)

参数

表 NuxsqlCommand 参数说明

名称	描述
cmdText（输入）	查询的文本。
connection（输入）	表示一个到 UXDB 服务器连接的 NuxsqlConnection 对象。
transaction（输入）	执行该 NuxsqlCommand 所在的事务（NuxsqlTransaction）。

返回值

返回一个 NuxsqlCommand 对象。

8.2.10.CommandText

功能

获取或设置要在数据源执行的 SQL 语句或函数（存储过程）。
函数
```
String CommandText
```
参数：无。
返回值

返回/设置命令文本。

8.2.11.CommandTimeout

功能

获取或设置在终止命令执行尝试并生成错误前的等待时间。
函数
```
Int32 CommandTimeout
```
参数：无。
返回值

返回/设置命令超时时间。

8.2.12.CommandType

功能

获取或设置一个值，指示如何解释 CommandText 属性。
函数
```
CommandType CommandType
```
参数：无。
返回值

返回/设置命令类型。

8.2.13.Connection

功能

获取或设置该 NuxsqlCommand 实例所使用的 NuxsqlConnection。
函数
```
NuxsqlConnection Connection
```
参数：无。
返回值

返回/设置连接。

8.2.14.Parameters

功能

获取 NuxsqlParameterCollection。
函数
```
NuxsqlParameterCollection Parameters
```
参数：无。
返回值

返回/设置参数集合。

8.2.15.Transaction

功能

获取或设置执行该 NuxsqlCommand 所在的事务 NuxsqlTransaction。
函数
```
NuxsqlTransaction Transaction
```
参数：无。
返回值

返回/设置所属事务。

8.2.16.UpdatedRowSource

功能

获取或设置当由 DbDataAdapter 的 Update 方法使用时，命令结果如何应用到 DataRow。
函数
```
UpdateRowSource UpdatedRowSource
```
参数：无。
返回值

返回/设置更新行来源。

8.2.17.LastInsertedOID

功能

返回所插入行的 OID。仅在使用 ExecuteNonQuery 且命令只插入单行时更新。若表创建时不带 OID，则该值始终为 0。
函数
```
Int64 LastInsertedOID
```
参数：无。
返回值

返回/设置最后插入行的 OID。

8.2.18.IsPrepared

功能

返回该查询是否将作为预编译（已编译）查询执行。
函数
```
bool IsPrepared
```
参数：无。
返回值

返回/设置是否已预处理。

8.2.19.Cancel

功能

尝试取消 NuxsqlCommand 的执行。
函数
```
void Cancel()
```
参数：无。
返回值

无返回值。

8.2.20.Clone

功能

基于当前命令创建一个新的命令。
函数
```
NuxsqlCommand Clone()
```
参数：无。
返回值

一个新的 NuxsqlCommand 对象。

8.2.21.CreateParameter

功能

创建一个 NuxsqlParameter 对象的新实例。
函数
```
NuxsqlParameter CreateParameter()
```
参数：无。
返回值

一个 NuxsqlParameter 对象。

8.2.22.DesignTimeVisible

功能

设计时可见。
函数
```
bool DesignTimeVisible
```
参数：无。
返回值

返回/设置设计时是否可见。

8.3.NuxsqlDataReader（数据读取器，对应 DbDataReader）

8.3.1.ReaderClosed

功能

每当调用 Close() 时触发。
函数
```
EventHandler ReaderClosed
```
参数：无。
返回值：无。

8.3.2.GetDataTypeName

功能

返回指定索引处列的数据类型名称。
函数
```
String GetDataTypeName(Int32 Index)
```
参数

表 GetDataTypeName 参数说明

名称描述

Index（输入）位置序号。
返回值

返回列的数据类型名。

名称	描述
Index（输入）	位置序号。

8.3.3.GetFieldType

功能

返回指定索引处列的数据类型。
函数
```
Type GetFieldType(Int32 Index)
```
参数

表 GetFieldType 参数说明

名称描述

Index（输入）位置序号。
返回值

返回列对应的 .NET 类型。

名称	描述
Index（输入）	位置序号。

8.3.4.GetProviderSpecificFieldType

功能

返回所请求序号处列的 Nuxsql 专用数据类型。

函数

Type GetProviderSpecificFieldType(int ordinal)

参数

表 GetProviderSpecificFieldType 参数说明

名称描述

ordinal（输入）列的位置。
返回值

适用于该列的 Nuxsql 类型。

名称	描述
ordinal（输入）	列的位置。

8.3.5.FieldCount

功能

获取当前行中的列数。
函数
```
Int32 FieldCount
```
参数：无。
返回值

返回/设置字段（列）数。

8.3.6.GetName

功能

返回指定索引处列的列名。
函数
```
String GetName(Int32 Index)
```
参数

表 GetName 参数说明

名称描述

Index（输入）位置序号。
返回值

返回名称。

名称	描述
Index（输入）	位置序号。

8.3.7.GetDataTypeOID

功能

返回指定索引处列的数据类型 OID。
函数
```
String GetDataTypeOID(Int32 Index)
```
参数

表 GetDataTypeOID 参数说明

名称描述

Index（输入）位置序号。
返回值

返回列的数据类型 OID。

名称	描述
Index（输入）	位置序号。

8.3.8.this[索引器]

功能

按序号或列名取当前行的列值
函数
```
Object this[Int32 i]
```
参数

表 this[索引器] 参数说明

名称描述

i（输入）序号（从 0 开始）。
返回值

返回当前行列值。

名称	描述
i（输入）	序号（从 0 开始）。

8.3.9.HasOrdinal

功能

是否存在指定序号。
函数
```
bool HasOrdinal(string fieldName)
```
参数

表 HasOrdinal 参数说明

名称描述

fieldName（输入）列名。
返回值

返回结果集中是否存在指定列名。

名称	描述
fieldName（输入）	列名。

8.3.10.GetOrdinal

功能

返回指定名称列的列名。
函数
```
Int32 GetOrdinal(String Name)
```
参数

表 GetOrdinal 参数说明

名称描述

Name（输入）列名。
返回值

返回列名对应的列序号。

名称	描述
Name（输入）	列名。

8.3.11.this[索引器]

功能

按序号或列名取当前行的列值
函数
```
Object this[String name]
```
参数

表 this[索引器] 参数说明

名称描述

name（输入）列名。
返回值

返回当前行列值。

名称	描述
name（输入）	列名。

8.3.12.GetFieldDbType

功能

返回指定索引处列的数据 DbType。
函数
```
DbType GetFieldDbType(Int32 Index)
```
参数

表 GetFieldDbType 参数说明

名称描述

Index（输入）位置序号。
返回值

返回列的 DbType。

名称	描述
Index（输入）	位置序号。

8.3.13.GetFieldNuxsqlDbType

功能

获取列的 UXDB 数据类型

函数

NuxsqlDbType GetFieldNuxsqlDbType(Int32 Index)

参数

表 GetFieldNuxsqlDbType 参数说明

名称描述

Index（输入）位置序号。
返回值

返回列的 UXDB 数据类型。

名称	描述
Index（输入）	位置序号。

8.3.14.GetBitString

功能

获取指定字段的值。
函数
```
BitString GetBitString(int i)
```
参数

表 GetBitString 参数说明

名称描述

i（输入）列序号（从 0 开始）。
返回值

返回位串列值。

名称	描述
i（输入）	列序号（从 0 开始）。

8.3.15.GetInterval

功能

以 NuxsqlInterval 形式获取某列的值。若应用程序不关心 NuxsqlInterval 与 TimeSpan 在处理天和月方面的差异，请改用 GetTimeSpan(Int32)。
函数
```
NuxsqlInterval GetInterval(Int32 i)
```
参数

表 GetInterval 参数说明

名称描述

i（输入）要查找的字段的索引。
返回值

该字段的 NuxsqlInterval 值。

名称	描述
i（输入）	要查找的字段的索引。

8.3.16.GetTime

功能

获取指定字段的值。
函数
```
NuxsqlTime GetTime(int i)
```
参数

表 GetTime 参数说明

名称描述

i（输入）列序号（从 0 开始）。
返回值

返回时间列值。

名称	描述
i（输入）	列序号（从 0 开始）。

8.3.17.GetTimeTZ

功能

获取指定字段的值。
函数
```
NuxsqlTimeTZ GetTimeTZ(int i)
```
参数

表 GetTimeTZ 参数说明

名称描述

i（输入）列序号（从 0 开始）。
返回值

返回带时区的时间列值。

名称	描述
i（输入）	列序号（从 0 开始）。

8.3.18.GetTimeStamp

功能

获取指定字段的值。
函数
```
NuxsqlTimeStamp GetTimeStamp(int i)
```
参数

表 GetTimeStamp 参数说明

名称描述

i（输入）列序号（从 0 开始）。
返回值

返回时间戳列值。

名称	描述
i（输入）	列序号（从 0 开始）。

8.3.19.GetTimeStampTZ

功能

获取指定字段的值。

函数

NuxsqlTimeStampTZ GetTimeStampTZ(int i)

参数

表 GetTimeStampTZ 参数说明

名称描述

i（输入）列序号（从 0 开始）。
返回值

返回带时区的时间戳列值。

名称	描述
i（输入）	列序号（从 0 开始）。

8.3.20.GetDate

功能

获取指定字段的值。
函数
```
NuxsqlDate GetDate(int i)
```
参数

表 GetDate 参数说明

名称描述

i（输入）列序号（从 0 开始）。
返回值

返回日期列值。

名称	描述
i（输入）	列序号（从 0 开始）。

8.3.21.GetGuid

功能

获取某列转换为 Guid 后的值。
函数
```
Guid GetGuid(Int32 i)
```
参数

表 GetGuid 参数说明

名称描述

i（输入）列序号（从 0 开始）。
返回值

返回全局唯一标识。

名称	描述
i（输入）	列序号（从 0 开始）。

8.3.22.GetInt16

功能

以 Int16 形式获取某列的值。
函数
```
Int16 GetInt16(Int32 i)
```
参数

表 GetInt16 参数说明

名称描述

i（输入）列序号（从 0 开始）。
返回值

返回16 位整数。

名称	描述
i（输入）	列序号（从 0 开始）。

8.3.23.GetInt32

功能

以 Int32 形式获取某列的值。
函数
```
Int32 GetInt32(Int32 i)
```
参数

表 GetInt32 参数说明

名称描述

i（输入）列序号（从 0 开始）。
返回值

返回32 位整数。

名称	描述
i（输入）	列序号（从 0 开始）。

8.3.24.GetInt64

功能

以 Int64 形式获取某列的值。
函数
```
Int64 GetInt64(Int32 i)
```
参数

表 GetInt64 参数说明

名称描述

i（输入）列序号（从 0 开始）。
返回值

返回64 位整数。

名称	描述
i（输入）	列序号（从 0 开始）。

8.3.25.GetFloat

功能

以 Single 形式获取某列的值。
函数
```
Single GetFloat(Int32 i)
```
参数

表 GetFloat 参数说明

名称描述

i（输入）列序号（从 0 开始）。
返回值

返回单精度浮点数。

名称	描述
i（输入）	列序号（从 0 开始）。

8.3.26.GetDouble

功能

以 Double 形式获取某列的值。
函数
```
Double GetDouble(Int32 i)
```
参数

表 GetDouble 参数说明

名称描述

i（输入）列序号（从 0 开始）。
返回值

返回双精度浮点数。

名称	描述
i（输入）	列序号（从 0 开始）。

8.3.27.GetString

功能

以 String 形式获取某列的值。
函数
```
String GetString(Int32 i)
```
参数

表 GetString 参数说明

名称描述

i（输入）列序号（从 0 开始）。
返回值

返回字符串。

名称	描述
i（输入）	列序号（从 0 开始）。

8.3.28.GetDecimal

功能

以 Decimal 形式获取某列的值。
函数
```
Decimal GetDecimal(Int32 i)
```
参数

表 GetDecimal 参数说明

名称描述

i（输入）列序号（从 0 开始）。
返回值

返回定点数。

名称	描述
i（输入）	列序号（从 0 开始）。

8.3.29.GetTimeSpan

功能

以 TimeSpan 形式获取某列的值。
函数
```
TimeSpan GetTimeSpan(Int32 i)
```
参数

表 GetTimeSpan 参数说明

名称描述

i（输入）列序号（从 0 开始）。
返回值

返回时间间隔列值。

名称	描述
i（输入）	列序号（从 0 开始）。

8.3.30.Depth

功能

获取当前行的嵌套深度。始终返回零。
函数
```
Int32 Depth
```
参数：无。
返回值

返回深度。

8.3.31.IsClosed

功能

获取一个值，指示数据读取器是否已关闭。
函数
```
Boolean IsClosed
```
参数：无。
返回值

返回/设置读取器是否已关闭。

8.3.32.GetValues

功能

将当前行中每一列的值复制到 values 中。
函数
```
Int32 GetValues(Object[] values)
```
参数

表 GetValues 参数说明

名称描述

values（输入）列值的存放目标。
返回值

已复制的列值数量。

名称	描述
values（输入）	列值的存放目标。

8.3.33.GetProviderSpecificValues

功能

将当前行中每一列的值复制到指定数组中。

函数

int GetProviderSpecificValues(object[] values)

参数

表 GetProviderSpecificValues 参数说明

名称描述

values（输入）大小足以存放所有列值的数组。
返回值

已复制的列值数量。

名称	描述
values（输入）	大小足以存放所有列值的数组。

8.3.34.GetBoolean

功能

以 Boolean 形式获取某列的值。
函数
```
Boolean GetBoolean(Int32 i)
```
参数

表 GetBoolean 参数说明

名称描述

i（输入）列序号（从 0 开始）。
返回值

返回布尔。

名称	描述
i（输入）	列序号（从 0 开始）。

8.3.35.GetByte

功能

以 Byte 形式获取某列的值。
函数
```
Byte GetByte(Int32 i)
```
参数

表 GetByte 参数说明

名称描述

i（输入）列序号（从 0 开始）。
返回值

返回字节。

名称	描述
i（输入）	列序号（从 0 开始）。

8.3.36.GetChar

功能

以 Char 形式获取某列的值。
函数
```
Char GetChar(Int32 i)
```
参数

表 GetChar 参数说明

名称描述

i（输入）列序号（从 0 开始）。
返回值

返回字符。

名称	描述
i（输入）	列序号（从 0 开始）。

8.3.37.GetDateTime

功能

以 DateTime 形式获取某列的值。
函数
```
DateTime GetDateTime(Int32 i)
```
参数

表 GetDateTime 参数说明

名称描述

i（输入）列序号（从 0 开始）。
返回值

返回日期时间。

名称	描述
i（输入）	列序号（从 0 开始）。

8.3.38.GetSchemaTable

功能

返回描述 DataReader 列元数据的 System.Data.DataTable。
函数
```
DataTable GetSchemaTable()
```
参数：无。
返回值

返回结果集的架构信息表。

8.3.39.GetEnumerator

功能

获取枚举器。
函数
```
IEnumerator GetEnumerator()
```
参数：无。
返回值

返回集合的遍历器。

8.4.NuxsqlDataAdapter（数据适配器，对应 DbDataAdapter）

8.4.1.RowUpdated

功能

行更新完成事件。

函数

NuxsqlRowUpdatedEventHandler RowUpdated

参数：无。
返回值：无。

8.4.2.RowUpdating

功能

行正在更新事件。

函数

NuxsqlRowUpdatingEventHandler RowUpdating

参数：无。
返回值：无。

8.4.3.NuxsqlDataAdapter

功能

默认构造函数。
函数
```
NuxsqlDataAdapter()
```
参数：无。
返回值

返回一个 NuxsqlDataAdapter 对象。

8.4.4.NuxsqlDataAdapter

功能

构造函数。

函数

NuxsqlDataAdapter(NuxsqlCommand selectCommand)

参数

表 NuxsqlDataAdapter 参数说明

名称描述

selectCommand（输入）查询命令对象。
返回值

返回一个 NuxsqlDataAdapter 对象。

名称	描述
selectCommand（输入）	查询命令对象。

8.4.5.NuxsqlDataAdapter

功能

构造函数。

函数

NuxsqlDataAdapter(String selectCommandText, NuxsqlConnection selectConnection) : this(new NuxsqlCommand(selectCommandText, selectConnection))

参数

表 NuxsqlDataAdapter 参数说明

名称描述

selectCommandText（输入）查询命令文本。

selectConnection（输入）查询命令所使用的连接对象。
返回值

返回一个 NuxsqlDataAdapter 对象。

名称	描述
selectCommandText（输入）	查询命令文本。
selectConnection（输入）	查询命令所使用的连接对象。

8.4.6.NuxsqlDataAdapter

功能

构造函数

函数

NuxsqlDataAdapter(String selectCommandText, String selectConnectionString) : this(selectCommandText, new NuxsqlConnection(selectConnectionString))

参数

表 NuxsqlDataAdapter 参数说明

名称描述

selectCommandText（输入）查询命令文本。

selectConnectionString（输入）连接字符串。
返回值

返回一个 NuxsqlDataAdapter 对象。

名称	描述
selectCommandText（输入）	查询命令文本。
selectConnectionString（输入）	连接字符串。

8.4.7.DeleteCommand

功能

删除命令。
函数
```
NuxsqlCommand DeleteCommand
```
参数：无。
返回值

返回/设置删除命令。

8.4.8.SelectCommand

功能

查询命令。
函数
```
NuxsqlCommand SelectCommand
```
参数：无。
返回值

返回/设置查询命令。

8.4.9.UpdateCommand

功能

更新命令。
函数
```
NuxsqlCommand UpdateCommand
```
参数：无。
返回值

返回/设置更新命令。

8.4.10.InsertCommand

功能

插入命令。
函数
```
NuxsqlCommand InsertCommand
```
参数：无。
返回值

返回/设置插入命令。

8.5.NuxsqlParameter（SQL 参数）

8.5.1.NuxsqlParameter

功能

初始化 NuxsqlParameter 类的新实例。
函数
```
NuxsqlParameter()
```
参数：无。
返回值

返回一个 NuxsqlParameter 对象。

8.5.2.NuxsqlParameter

功能

使用参数名和新 NuxsqlParameter 的值初始化 NuxsqlParameter 类的新实例。

函数

NuxsqlParameter(String parameterName, object value)

参数

表 NuxsqlParameter 参数说明

名称描述

parameterName（输入）参数名。

value（输入）参数值。
返回值

返回一个 NuxsqlParameter 对象。

8.5.3.Collection

功能

该参数所属的集合（若有）。
函数
```
NuxsqlParameterCollection Collection
```
参数：无。
返回值

返回/设置所属参数集合。

8.5.4.NuxsqlParameter

功能

使用参数名和数据类型初始化 NuxsqlParameter 类的新实例。

函数

NuxsqlParameter(String parameterName, NuxsqlDbType parameterType)

参数

表 NuxsqlParameter 参数说明

名称描述

parameterName（输入）参数名。

parameterType（输入）参数的数据类型。
返回值

返回一个 NuxsqlParameter 对象。

8.5.5.NuxsqlParameter

功能

构造函数

函数

NuxsqlParameter(String parameterName, DbType parameterType) : this(parameterName, NuxsqlTypesHelper.GetNativeTypeInfo(parameterType).NuxsqlDbType, 0, String.Empty)

参数

表 NuxsqlParameter 参数说明

名称描述

parameterName（输入）参数名。

parameterType（输入）参数的数据类型。
返回值

返回一个 NuxsqlParameter 对象。

8.5.6.NuxsqlParameter

功能

初始化 NuxsqlParameter 的新实例。

函数

NuxsqlParameter(String parameterName, NuxsqlDbType parameterType, Int32 size)

参数

表 NuxsqlParameter 参数说明

名称	描述
parameterName（输入）	参数名。
parameterType（输入）	参数的数据类型。
size（输入）	参数大小（字节数）。

返回值

返回一个 NuxsqlParameter 对象。

8.5.7.NuxsqlParameter

功能

构造函数

函数

NuxsqlParameter(String parameterName, DbType parameterType, Int32 size) : this(parameterName, NuxsqlTypesHelper.GetNativeTypeInfo(parameterType).NuxsqlDbType, size, String.Empty)

参数

表 NuxsqlParameter 参数说明

名称	描述
parameterName（输入）	参数名。
parameterType（输入）	参数的数据类型。
size（输入）	参数大小（字节数）。

返回值

返回一个 NuxsqlParameter 对象。

8.5.8.NuxsqlParameter

功能

初始化 NuxsqlParameter 的新实例。

函数

NuxsqlParameter(String parameterName, NuxsqlDbType parameterType, Int32 size, String sourceColumn)

参数

表 NuxsqlParameter 参数说明

名称	描述
parameterName（输入）	参数名。
parameterType（输入）	参数的数据类型。
size（输入）	参数大小（字节数）。
sourceColumn（输入）	源列名。

返回值

返回一个 NuxsqlParameter 对象。

8.5.9.NuxsqlParameter

功能

构造函数

函数

NuxsqlParameter(String parameterName, DbType parameterType, Int32 size, String sourceColumn) : this(parameterName, NuxsqlTypesHelper.GetNativeTypeInfo(parameterType).NuxsqlDbType, size, sourceColumn)

参数

表 NuxsqlParameter 参数说明

名称	描述
parameterName（输入）	参数名。
parameterType（输入）	参数的数据类型。
size（输入）	参数大小（字节数）。
sourceColumn（输入）	源列名。

返回值

返回一个 NuxsqlParameter 对象。

8.5.10.NuxsqlParameter

功能

初始化 NuxsqlParameter 的新实例。

函数

NuxsqlParameter(String parameterName, NuxsqlDbType parameterType, Int32 size, String sourceColumn, ParameterDirection direction, bool isNullable, byte precision, byte scale, DataRowVersion sourceVersion, object value)

参数

表 NuxsqlParameter 参数说明

名称	描述
parameterName（输入）	参数名。
parameterType（输入）	参数的数据类型。
size（输入）	参数大小（字节数）。
sourceColumn（输入）	源列名。
direction（输入）	参数方向。
isNullable（输入）	是否允许空值。
precision（输入）	数值精度。
scale（输入）	小数位数。
sourceVersion（输入）	来源数据行版本。
value（输入）	参数值。

返回值

返回一个 NuxsqlParameter 对象。

8.5.11.NuxsqlParameter

功能

构造函数

函数

NuxsqlParameter(String parameterName, DbType parameterType, Int32 size, String sourceColumn, ParameterDirection direction, bool isNullable, byte precision, byte scale, DataRowVersion sourceVersion, object value) : this( parameterName, NuxsqlTypesHelper.GetNativeTypeInfo(parameterType).NuxsqlDbType, size, sourceColumn, direction, isNullable, precision, scale, sourceVersion, value)

参数

表 NuxsqlParameter 参数说明

名称	描述
parameterName（输入）	参数名。
parameterType（输入）	参数的数据类型。
size（输入）	参数大小（字节数）。
sourceColumn（输入）	源列名。
direction（输入）	参数方向。
isNullable（输入）	是否允许空值。
precision（输入）	数值精度。
scale（输入）	小数位数。
sourceVersion（输入）	来源数据行版本。
value（输入）	参数值。

返回值

返回一个 NuxsqlParameter 对象。

8.5.12.Precision

功能

获取或设置用于表示 Value 属性的最大位数。
函数
```
Byte Precision
```
参数：无。
返回值

返回/设置数值精度。

8.5.13.UseCast

功能

包含在查询中时是否使用显式类型转换。
函数
```
Boolean UseCast
```
参数：无。
返回值

返回/设置是否使用类型转换。

8.5.14.Scale

功能

获取或设置 Value 解析到的小数位数。
函数
```
Byte Scale
```
参数：无。
返回值

返回/设置小数位数。

8.5.15.Size

功能

获取或设置列中数据的最大大小（以字节为单位）。
函数
```
Int32 Size
```
参数：无。
返回值

返回/设置大小。

8.5.16.DbType

功能

获取或设置参数的 DbType。
函数
```
DbType DbType
```
参数：无。
返回值

返回/设置数据提供程序类型。

8.5.17.NuxsqlDbType

功能

获取或设置参数的 DbType。
函数
```
NuxsqlDbType NuxsqlDbType
```
参数：无。
返回值

返回/设置UXDB 数据类型。

8.5.18.Direction

功能

获取或设置一个值，指示参数是仅输入、仅输出、双向，还是存储过程返回值参数。
函数
```
ParameterDirection Direction
```
参数：无。
返回值

返回/设置参数方向。

8.5.19.IsNullable

功能

获取或设置一个值，指示参数是否接受 null 值。
函数
```
Boolean IsNullable
```
参数：无。
返回值

返回/设置是否允许空值。

8.5.20.ParameterName

功能

获取或设置 NuxsqlParameter 的名称。
函数
```
String ParameterName
```
参数：无。
返回值

返回/设置参数名。

8.5.21.SourceColumn

功能

获取或设置映射到 DataSet 并用于加载或返回 Value 的源列名称。
函数
```
String SourceColumn
```
参数：无。
返回值

返回/设置来源列名。

8.5.22.SourceVersion

功能

获取或设置加载 Value 时使用的 DataRowVersion。
函数
```
DataRowVersion SourceVersion
```
参数：无。
返回值

返回/设置来源数据行版本。

8.5.23.Value

功能

获取或设置参数的值。
函数
```
Object Value
```
参数：无。
返回值

返回值。

8.5.24.NuxsqlValue

功能

获取或设置参数的值。
函数
```
Object NuxsqlValue
```
参数：无。
返回值

返回/设置UXDB 原生值。

8.5.25.ResetDbType

功能

重置 DBType。
函数
```
void ResetDbType()
```
参数：无。
返回值

无返回值。

8.5.26.SourceColumnNullMapping

功能

源列映射。
函数
```
bool SourceColumnNullMapping
```
参数：无。
返回值

返回/设置源列空值映射。

8.5.27.Clone

功能

创建一个作为当前实例副本的新的 NuxsqlParameter。
函数
```
NuxsqlParameter Clone()
```
参数：无。
返回值

作为当前实例副本的新的 NuxsqlParameter。

8.6.NuxsqlParameterCollection（参数集合）

8.6.1.this[索引器]

功能

按名称或序号取参数

函数

NuxsqlParameter this[string parameterName]

参数

表 this[索引器] 参数说明

名称描述

parameterName（输入）参数名。
返回值

返回当前行列值。

8.6.2.this[索引器]

功能

按名称或序号取参数
函数
```
NuxsqlParameter this[int index]
```
参数

表 this[索引器] 参数说明

名称描述

index（输入）序号（从 0 开始）。
返回值

返回当前行列值。

8.6.3.Add

功能

将指定的 NuxsqlParameter 对象添加到 NuxsqlParameterCollection。

函数

NuxsqlParameter Add(NuxsqlParameter value)

参数

表 Add 参数说明

名称描述

value（输入）要添加到集合中的 NuxsqlParameter。
返回值

新 NuxsqlParameter 对象的索引。

8.6.4.Add

功能

已过时。请改用 AddWithValue。

函数

NuxsqlParameter Add(string parameterName, object value)

参数

表 Add 参数说明

名称描述

parameterName（输入）参数名。

value（输入）参数值。
返回值

返回添加后的结果。

8.6.5.AddWithValue

功能

根据指定的参数名和值，向 NuxsqlParameterCollection 添加一个 NuxsqlParameter。

函数

NuxsqlParameter AddWithValue(string parameterName, object value)

参数

表 AddWithValue 参数说明

名称描述

parameterName（输入） NuxsqlParameter 的名称。

value（输入）要添加到集合中的 NuxsqlParameter 的 Value。
返回值

所添加的参数。

8.6.6.AddWithValue

功能

根据指定的参数名和值，向 NuxsqlParameterCollection 添加一个 NuxsqlParameter。

函数

NuxsqlParameter AddWithValue(string parameterName, NuxsqlDbType parameterType, object value)

参数

表 AddWithValue 参数说明

名称	描述
parameterName（输入）	NuxsqlParameter 的名称。
parameterType（输入）	NuxsqlDbType 枚举值之一。
value（输入）	要添加到集合中的 NuxsqlParameter 的 Value。

返回值

所添加的参数。

8.6.7.AddWithValue

功能

根据指定的参数名和值，向 NuxsqlParameterCollection 添加一个 NuxsqlParameter。

函数

NuxsqlParameter AddWithValue(string parameterName, NuxsqlDbType parameterType, int size, object value)

参数

表 AddWithValue 参数说明

名称	描述
parameterName（输入）	NuxsqlParameter 的名称。
parameterType（输入）	NuxsqlDbType 枚举值之一。
size（输入）	列的长度。
value（输入）	要添加到集合中的 NuxsqlParameter 的 Value。

返回值

所添加的参数。

8.6.8.AddWithValue

功能

根据指定的参数名和值，向 NuxsqlParameterCollection 添加一个 NuxsqlParameter。

函数

NuxsqlParameter AddWithValue(string parameterName, NuxsqlDbType parameterType, int size, string sourceColumn, object value)

参数

表 AddWithValue 参数说明

名称	描述
parameterName（输入）	NuxsqlParameter 的名称。
parameterType（输入）	NuxsqlDbType 枚举值之一。
size（输入）	列的长度。
sourceColumn（输入）	源列的名称。
value（输入）	要添加到集合中的 NuxsqlParameter 的 Value。

返回值

所添加的参数。

8.6.9.Add

功能

已过时。请改用 AddWithValue。

函数

NuxsqlParameter Add(string parameterName, NuxsqlDbType parameterType)

参数

表 Add 参数说明

名称描述

parameterName（输入）参数名。

parameterType（输入）参数的数据类型。
返回值

返回添加后的结果。

8.6.10.Add

功能

根据参数名、数据类型和列长度，向 NuxsqlParameterCollection 添加一个 NuxsqlParameter。

函数

NuxsqlParameter Add(string parameterName, NuxsqlDbType parameterType, int size)

参数

表 Add 参数说明

名称	描述
parameterName（输入）	参数名称。
parameterType（输入）	DbType 枚举值之一。
size（输入）	列的长度。

返回值

新 NuxsqlParameter 对象的索引。

8.6.11.Add

功能

根据参数名、数据类型、列长度和源列名，向 NuxsqlParameterCollection 添加一个 NuxsqlParameter。

函数

NuxsqlParameter Add(string parameterName, NuxsqlDbType parameterType, int size, string sourceColumn)

参数

表 Add 参数说明

名称	描述
parameterName（输入）	参数名称。
parameterType（输入）	DbType 枚举值之一。
size（输入）	列的长度。
sourceColumn（输入）	源列的名称。

返回值

新 NuxsqlParameter 对象的索引。

8.6.12.RemoveAt

功能

按参数名从集合中移除指定的 NuxsqlParameter。
函数
```
void RemoveAt(string parameterName)
```
参数

表 RemoveAt 参数说明

名称描述

parameterName（输入）要获取的 NuxsqlParameter 对象的名称。
返回值

无返回值。

8.6.13.Contains

功能

获取一个值，指示集合中是否存在具有指定参数名的 NuxsqlParameter。
函数
```
bool Contains(string parameterName)
```
参数

表 Contains 参数说明

名称描述

parameterName（输入）要查找的 NuxsqlParameter 对象的名称。
返回值

若集合包含该参数则为 true，否则为 false。

8.6.14.IndexOf

功能

获取具有特定参数名的 NuxsqlParameter 在集合中的位置。
函数
```
int IndexOf(string parameterName)
```
参数

表 IndexOf 参数说明

名称描述

parameterName（输入）要查找的 NuxsqlParameter 对象的名称。
返回值

NuxsqlParameter 在集合中的从零开始的位置。

8.6.15.IsReadOnly

功能

报告集合是否为只读。始终为 false。
函数
```
bool IsReadOnly
```
参数：无。
返回值

返回/设置是否只读。

8.6.16.RemoveAt

功能

按参数名从集合中移除指定的 NuxsqlParameter。
函数
```
void RemoveAt(int index)
```
参数

表 RemoveAt 参数说明

名称描述

index（输入）位置序号。
返回值

无返回值。

8.6.17.Insert

功能

在指定索引处将一个 NuxsqlParameter 插入集合。
函数
```
void Insert(int index, object oValue)
```

参数

表 Insert 参数说明

名称	描述
index（输入）	参数插入到集合中的从零开始的索引位置。
oValue（输入）	要添加到集合中的 NuxsqlParameter。

返回值

无返回值。

8.6.18.Remove

功能

从集合中移除指定的 NuxsqlParameter。
函数
```
void Remove(string parameterName)
```
参数

表 Remove 参数说明

名称描述

parameterName（输入）要从集合中移除的 NuxsqlParameter 的名称。
返回值

无返回值。

8.6.19.Remove

功能

从集合中移除指定的 NuxsqlParameter。
函数
```
void Remove(object oValue)
```
参数

表 Remove 参数说明

名称描述

oValue（输入）要插入或移除的对象。
返回值

无返回值。

8.6.20.Contains

功能

获取一个值，指示集合中是否存在具有指定参数名的 NuxsqlParameter。
函数
```
bool Contains(object value)
```
参数

表 Contains 参数说明

名称描述

value（输入）参数值。
返回值

若集合包含该参数则为 true，否则为 false。

8.6.21.TryGetValue

功能

获取一个值，指示集合中是否存在具有指定参数名的 NuxsqlParameter。

函数

bool TryGetValue(string parameterName, out NuxsqlParameter parameter)

参数

表 TryGetValue 参数说明

名称	描述
parameterName（输入）	要查找的 NuxsqlParameter 对象的名称。
parameter（输出）	若在集合中找到所请求的参数，则通过此 out 参数返回其引用；若未找到则为 null。

返回值

若集合包含该参数且 param 将包含该参数则为 true，否则为 false。

8.6.22.Clear

功能

从集合中移除所有项。
函数
```
void Clear()
```
参数：无。
返回值

无返回值。

8.6.23.IndexOf

功能

获取具有特定参数名的 NuxsqlParameter 在集合中的位置。
函数
```
int IndexOf(object value)
```
参数

表 IndexOf 参数说明

名称描述

value（输入）参数值。
返回值

NuxsqlParameter 在集合中的从零开始的位置。

8.6.24.Add

功能

将指定的 NuxsqlParameter 对象添加到 NuxsqlParameterCollection。
函数
```
int Add(object value)
```
参数

表 Add 参数说明

名称描述

value（输入）要添加到集合中的 NuxsqlParameter。
返回值

新 NuxsqlParameter 对象的索引。

8.6.25.IsFixedSize

功能

报告集合是否为固定大小。始终为 false。
函数
```
bool IsFixedSize
```
参数：无。
返回值

返回/设置是否固定大小。

8.6.26.IsSynchronized

功能

报告集合是否已同步。
函数
```
bool IsSynchronized
```
参数：无。
返回值

返回/设置是否线程安全。

8.6.27.Count

功能

获取集合中 NuxsqlParameter 对象的数量。
函数
```
int Count
```
参数：无。
返回值

返回/设置元素个数。

8.6.28.CopyTo

功能

将 NuxsqlParameterCollection 中的 NuxsqlParameter 对象复制到指定数组。
函数
```
void CopyTo(Array array, int index)
```
参数

表 CopyTo 参数说明

名称描述

array（输入）用于复制集合中 NuxsqlParameter 对象的目标数组。

index（输入）数组的起始索引。
返回值

无返回值。

8.6.29.SyncRoot

功能

同步根对象。
函数
```
object SyncRoot
```
参数：无。
返回值

返回/设置同步根对象。

8.6.30.GetEnumerator

功能

返回可用于遍历集合的枚举器。
函数
```
IEnumerator GetEnumerator()
```
参数：无。
返回值

可用于遍历集合的 IEnumerator。

8.6.31.AddRange

功能

向集合添加一个参数数组。
函数
```
void AddRange(Array values)
```
参数

表 AddRange 参数说明

名称描述

values（输入）要添加的参数。
返回值

无返回值。

8.6.32.IndexOf

功能

报告给定参数在集合中的偏移量。
函数
```
int IndexOf(NuxsqlParameter item)
```
参数

表 IndexOf 参数说明

名称描述

item（输入）要查找的参数。
返回值

参数的索引；若参数不存在则为 -1。

8.6.33.Insert

功能

在指定索引处将一个 NuxsqlParameter 插入集合。

函数

void Insert(int index, NuxsqlParameter item)

参数

表 Insert 参数说明

名称描述

index（输入）参数插入到集合中的从零开始的索引位置。

item（输入）集合元素。
返回值

无返回值。

8.6.34.Contains

功能

报告集合中是否存在指定参数。
函数
```
bool Contains(NuxsqlParameter item)
```
参数

表 Contains 参数说明

名称描述

item（输入）要查找的参数。
返回值

若找到该参数则为 true，否则为 false。

8.6.35.Remove

功能

从集合中移除指定参数。
函数
```
bool Remove(NuxsqlParameter item)
```
参数

表 Remove 参数说明

名称描述

item（输入）要移除的参数。
返回值

若找到并移除了该参数则为 true，否则为 false。

8.6.36.CopyTo

功能

将 NuxsqlParameterCollection 中的 NuxsqlParameter 对象复制到指定数组。

函数

void CopyTo(NuxsqlParameter[] array, int arrayIndex)

参数

表 CopyTo 参数说明

名称描述

array（输入）用于复制集合中 NuxsqlParameter 对象的目标数组。

arrayIndex（输入）数组起始索引。
返回值

无返回值。

8.6.37.ToArray

功能

将集合转换为 System.Array。
函数
```
NuxsqlParameter[] ToArray()
```
参数：无。
返回值

NuxsqlParameter 数组。

8.7.NuxsqlTransaction（事务对象）

8.7.1.Connection

功能

获取与该事务关联的 NuxsqlConnection 对象；若事务已不再有效则为 null 引用。
函数
```
NuxsqlConnection Connection
```
参数：无。
返回值

返回连接。

8.7.2.IsolationLevel

功能

指定该事务的 IsolationLevel。
函数
```
IsolationLevel IsolationLevel
```
参数：无。
返回值

返回/设置事务隔离级别。

8.7.3.Commit

功能

提交数据库事务。
函数
```
void Commit()
```
参数：无。
返回值

无返回值。

8.7.4.Rollback

功能

从挂起状态回滚事务。
函数
```
void Rollback()
```
参数：无。
返回值

无返回值。

8.7.5.Rollback

功能

从挂起的保存点状态回滚事务。
函数
```
void Rollback(String savePointName)
```
参数

表 Rollback 参数说明

名称描述

savePointName（输入）保存点名称。
返回值

无返回值。

8.7.6.Save

功能

创建一个事务保存点。
函数
```
void Save(String savePointName)
```
参数

表 Save 参数说明

名称描述

savePointName（输入）保存点名称。
返回值

无返回值。

8.8.NuxsqlException（驱动异常）

8.8.1.GetObjectData

功能

获取对象数据。

函数

void GetObjectData(SerializationInfo info, StreamingContext context)

参数

表 GetObjectData 参数说明

名称描述

info（输入）序列化信息对象。

context（输入）流上下文对象。
返回值

无返回值。

8.8.2.this[索引器]

功能

按序号取错误明细
函数
```
NuxsqlError this[Int32 Index]
```
参数

表 this[索引器] 参数说明

名称描述

Index（输入）序号（从 0 开始）。
返回值

返回当前行列值。

8.8.3.this[索引器]

功能

按序号取错误明细
函数
```
String Severity
```
参数：无。
返回值

返回/设置按序号取错误明细。

8.8.4.this[索引器]

功能

按序号取错误明细
函数
```
String Code
```
参数：无。
返回值

返回/设置按序号取错误明细。

8.8.5.this[索引器]

功能

按序号取错误明细
函数
```
String BaseMessage
```
参数：无。
返回值

返回/设置按序号取错误明细。

8.8.6.this[索引器]

功能

按序号取错误明细
函数
```
String Detail
```
参数：无。
返回值

返回/设置按序号取错误明细。

8.8.7.this[索引器]

功能

按序号取错误明细
函数
```
String Hint
```
参数：无。
返回值

返回/设置按序号取错误明细。

8.8.8.this[索引器]

功能

按序号取错误明细
函数
```
String Position
```
参数：无。
返回值

返回/设置按序号取错误明细。

8.8.9.this[索引器]

功能

按序号取错误明细
函数
```
String Where
```
参数：无。
返回值

返回/设置按序号取错误明细。

8.8.10.this[索引器]

功能

按序号取错误明细
函数
```
String File
```
参数：无。
返回值

返回/设置按序号取错误明细。

8.8.11.this[索引器]

功能

按序号取错误明细
函数
```
String Line
```
参数：无。
返回值

返回/设置按序号取错误明细。

8.8.12.this[索引器]

功能

按序号取错误明细
函数
```
String Routine
```
参数：无。
返回值

返回/设置按序号取错误明细。

8.8.13.this[索引器]

功能

按序号取错误明细
函数
```
String SchemaName
```
参数：无。
返回值

返回/设置按序号取错误明细。

8.8.14.this[索引器]

功能

按序号取错误明细
函数
```
String TableName
```
参数：无。
返回值

返回/设置按序号取错误明细。

8.8.15.this[索引器]

功能

按序号取错误明细
函数
```
String ColumnName
```
参数：无。
返回值

返回/设置按序号取错误明细。

8.8.16.this[索引器]

功能

按序号取错误明细
函数
```
String DataTypeName
```
参数：无。
返回值

返回/设置按序号取错误明细。

8.8.17.this[索引器]

功能

按序号取错误明细
函数
```
String ConstraintName
```
参数：无。
返回值

返回/设置按序号取错误明细。

8.8.18.this[索引器]

功能

按序号取错误明细
函数
```
String ErrorSql
```
参数：无。
返回值

返回/设置按序号取错误明细。

8.8.19.Errors

功能

返回 UXDB 后端提供的完整错误列表。
函数
```
IList Errors
```
参数：无。
返回值

返回/设置错误明细集合。

8.8.20.ToString

功能

生成 .NET 风格的异常字符串。包含列表中所有错误，以及任何提示信息。
函数
```
String ToString()
```
参数：无。
返回值

返回对象的字符串表示。

8.9.NuxsqlConnectionStringBuilder（连接字符串构建器）

8.9.1.NuxsqlConnectionStringBuilder

功能

初始化 NuxsqlConnectionStringBuilder 类的新实例。
函数
```
NuxsqlConnectionStringBuilder()
```
参数：无。
返回值

返回一个 NuxsqlConnectionStringBuilder 对象。

8.9.2.NuxsqlConnectionStringBuilder

功能

初始化 NuxsqlConnectionStringBuilder 类的新实例，可选择使用 ODBC 规则为值加引号。

函数

NuxsqlConnectionStringBuilder(string connectionString)

参数

表 NuxsqlConnectionStringBuilder 参数说明

名称描述

connectionString（输入）连接字符串。
返回值

返回一个 NuxsqlConnectionStringBuilder 对象。

8.9.3.Clone

功能

返回该 NuxsqlConnectionString 的精确副本。
函数
```
NuxsqlConnectionStringBuilder Clone()
```
参数：无。
返回值

返回克隆后的对象。

8.9.4.Host

功能

获取或设置后端服务器主机名。
函数
```
string Host
```
参数：无。
返回值

返回主机名。

8.9.5.Port

功能

获取或设置后端服务器端口。
函数
```
int Port
```
参数：无。
返回值

返回端口号。

8.9.6.Database

功能

获取或设置连接打开后要使用的数据库名称。
函数
```
string Database
```
参数：无。
返回值

返回/设置数据库名。

8.9.7.UserName

功能

获取或设置登录用户名。
函数
```
string UserName
```
参数：无。
返回值

返回/设置用户名。

8.9.8.PasswordAsByteArray

功能

获取或设置以 UTF8 编码的字节数组形式表示的登录密码。
函数
```
byte[] PasswordAsByteArray
```
参数：无。
返回值

返回/设置口令的字节数组形式。

8.9.9.Password

功能

以字符串形式设置登录密码。
函数
```
string Password
```
参数：无。
返回值

返回/设置口令（只写，读取时返回空串）。

8.9.10.SSL

功能

获取或设置一个值，指示是否尝试使用 SSL。
函数
```
bool SSL
```
参数：无。
返回值

返回/设置是否启用 SSL。

8.9.11.SslMode

功能

获取或设置一个值，指示是否尝试使用 SSL。
函数
```
SslMode SslMode
```
参数：无。
返回值

返回 SSL 连接模式。

8.9.12.Timeout

功能

获取或设置在尝试建立连接时，终止尝试并生成错误前的等待时间。
函数
```
int Timeout
```
参数：无。
返回值

返回超时。

8.9.13.SearchPath

功能

获取或设置模式搜索路径。
函数
```
string SearchPath
```
参数：无。
返回值

返回搜索路径。

8.9.14.Pooling

功能

获取或设置一个值，指示是否使用连接池。
函数
```
bool Pooling
```
参数：无。
返回值

返回连接池。

8.9.15.ConnectionLifeTime

功能

获取或设置在所有连接数超过 MinPoolSize 时，关闭池中未使用连接前等待的时间。
函数
```
int ConnectionLifeTime
```
参数：无。
返回值

返回/设置连接存活时长。

8.9.16.MinPoolSize

功能

获取或设置连接池的最小大小。
函数
```
int MinPoolSize
```
参数：无。
返回值

返回连接池最小连接数。

8.9.17.MaxPoolSize

功能

获取或设置连接池的最大大小。
函数
```
int MaxPoolSize
```
参数：无。
返回值

返回连接池最大连接数。

8.9.18.SyncNotification

功能

获取或设置一个值，指示是否监听通知并在命令执行的间隙上报它们。
函数
```
bool SyncNotification
```
参数：无。
返回值

返回/设置是否使用同步通知。

8.9.19.CommandTimeout

功能

获取在尝试执行命令时，终止尝试并生成错误前的等待时间。
函数
```
int CommandTimeout
```
参数：无。
返回值

返回/设置命令超时时间。

8.9.20.Enlist

功能

是否登记到环境的 TransactionScope。
函数
```
bool Enlist
```
参数：无。
返回值

返回事务登记。

8.9.21.PreloadReader

功能

获取或设置一个值，指示是否整体加载数据读取器（为兼容早期代码）。
函数
```
bool PreloadReader
```
参数：无。
返回值

返回/设置是否预加载读取器。

8.9.22.UseExtendedTypes

功能

已过时，参见 http://www.npgsql.org/doc/3.0/migration.html
函数
```
bool UseExtendedTypes
```
参数：无。
返回值

返回/设置是否启用扩展类型。

8.9.23.IntegratedSecurity

功能

是否使用 Windows 集成安全性登录。
函数
```
bool IntegratedSecurity
```
参数：无。
返回值

返回集成认证。

8.9.24.IncludeRealm

功能

用于身份认证的 Kerberos 领域。
函数
```
bool IncludeRealm
```
参数：无。
返回值

返回/设置是否在用户名中包含域。

8.9.25.Compatible

功能

兼容性版本。在可能的情况下，若该版本低于引入破坏性变更的版本，则由破坏性变更引起的行为将被保留。
函数
```
Version Compatible
```
参数：无。
返回值

返回兼容。

8.9.26.ApplicationName

功能

获取或设置连接建立期间发送到后端的可选应用程序名称参数。
函数
```
string ApplicationName
```
参数：无。
返回值

返回应用程序名称。

8.9.27.AlwaysPrepare

功能

获取或设置一个值，指示是否在执行前静默地对所有命令执行 Prepare()。
函数
```
bool AlwaysPrepare
```
参数：无。
返回值

返回/设置是否总是预处理命令。

8.9.28.Protocol

功能

获取或设置指定的后端通信协议版本。
函数
```
ProtocolVersion Protocol
```
参数：无。
返回值

返回/设置协议。

8.9.29.Encoding

功能

获取后端编码。始终返回 “UTF8”。
函数
```
string Encoding
```
参数：无。
返回值

返回/设置编码。

8.9.30.this[索引器]

功能

按索引取元素
函数
```
object this[string keyword]
```
参数

表 this[索引器] 参数说明

名称描述

keyword（输入）关键字。
返回值

返回当前行列值。

8.9.31.this[索引器]

功能

按索引取元素
函数
```
object this[Keywords keyword]
```
参数

表 this[索引器] 参数说明

名称描述

keyword（输入）关键字。
返回值

返回当前行列值。

8.9.32.Remove

功能

从 DbConnectionStringBuilder 实例中移除具有指定键的条目。
函数
```
bool Remove(string keyword)
```
参数

表 Remove 参数说明

名称描述

keyword（输入）要从该 DbConnectionStringBuilder 的连接字符串中移除的键/值对的键。
返回值

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

8.9.33.ContainsKey

功能

判断 NuxsqlConnectionStringBuilder 是否包含指定的键。
函数
```
bool ContainsKey(Keywords keyword)
```
参数

表 ContainsKey 参数说明

名称描述

keyword（输入）要在 NuxsqlConnectionStringBuilder 中定位的键。
返回值

若 NuxsqlConnectionStringBuilder 包含指定键的条目则为 true，否则为 false。

8.9.34.TryGetValue

功能

从该 NuxsqlConnectionStringBuilder 检索与所给键对应的值。

函数

bool TryGetValue(string keyword, out object value)

参数

表 TryGetValue 参数说明

名称描述

keyword（输入）要获取的项的键。

value（输出）与该键对应的值。
返回值

若在连接字符串中找到该关键字则为 true，否则为 false。

8.9.35.Clear

功能

清除成员并将其设为默认值。
函数
```
void Clear()
```
参数：无。
返回值

无返回值。

8.10.NuxsqlError（服务端错误信息）

8.10.1.Severity

功能

严重级别代码。适用于所有版本。
函数
```
String Severity
```
参数：无。
返回值

返回/设置错误严重级别。

8.10.2.Code

功能

错误码。需要 UXDB 2.0 及以上版本。
函数
```
String Code
```
参数：无。
返回值

返回/设置SQLSTATE 错误码。

8.10.3.Message

功能

简要错误消息。适用于所有版本。
函数
```
String Message
```
参数：无。
返回值

返回消息。

8.10.4.Detail

功能

详细错误消息。需要 UXDB 2.0 及以上版本。
函数
```
String Detail
```
参数：无。
返回值

返回/设置错误详情。

8.10.5.Hint

功能

有助于解决该错误的建议。需要 UXDB 2.0 及以上版本。
函数
```
String Hint
```
参数：无。
返回值

返回/设置处理提示。

8.10.6.Position

功能

查询字符串中发生错误的位置（从 1 开始计数）。
函数
```
String Position
```
参数：无。
返回值

返回/设置出错位置。

8.10.7.InternalPosition

功能

查询字符串中发生错误的位置（从 1 开始计数）。该位置指向内部执行的命令，例如在 PL/pgSQL 函数内部执行的命令。
函数
```
String InternalPosition
```
参数：无。
返回值

返回/设置内部位置。

8.10.8.InternalQuery

功能

发生错误的内部查询字符串。该位置指向内部执行的命令，例如在 PL/pgSQL 函数内部执行的命令。
函数
```
String InternalQuery
```
参数：无。
返回值

返回/设置内部查询。

8.10.9.Where

功能

回溯信息。
函数
```
String Where
```
参数：无。
返回值

返回/设置出错上下文。

8.10.10.File

功能

报告错误的源文件（后端中）。
函数
```
String File
```
参数：无。
返回值

返回/设置错误所在源文件。

8.10.11.Line

功能

报告错误的源文件行号（后端中）。
函数
```
String Line
```
参数：无。
返回值

返回/设置错误所在行号。

8.10.12.Routine

功能

报告错误的源例程（后端中）。
函数
```
String Routine
```
参数：无。
返回值

返回/设置出错例程。

8.10.13.SchemaName

功能

与错误相关的模式名。
函数
```
String SchemaName
```
参数：无。
返回值

返回/设置模式名。

8.10.14.TableName

功能

与错误相关的表名。
函数
```
String TableName
```
参数：无。
返回值

返回/设置表名。

8.10.15.ColumnName

功能

与错误相关的列名。
函数
```
String ColumnName
```
参数：无。
返回值

返回/设置列名。

8.10.16.DataTypeName

功能

与错误相关的列的数据类型。
函数
```
String DataTypeName
```
参数：无。
返回值

返回/设置数据类型名。

8.10.17.ConstraintName

功能

与错误相关的约束名。
函数
```
String ConstraintName
```
参数：无。
返回值

返回/设置约束名。

8.10.18.ErrorSql

功能

包含导致该错误的已发送 SQL 的字符串。
函数
```
String ErrorSql
```
参数：无。
返回值

返回/设置出错的 SQL。

8.10.19.ToString

功能

返回该错误对象的字符串表示。
函数
```
String ToString()
```
参数：无。
返回值

返回对象的字符串表示。

8.11.NuxsqlFactory（数据源工厂（DbProviderFactory））

8.11.1.Instance

功能

获取 NuxsqlFactory 的实例。可用于检索强类型的数据对象。

函数

NuxsqlFactory Instance = new NuxsqlFactory()

参数：无。
返回值

返回当前实例。

8.11.2.CreateCommand

功能

创建一个 NuxsqlCommand 对象。
函数
```
DbCommand CreateCommand()
```
参数：无。
返回值

返回创建的命令对象。

8.11.3.CreateCommandBuilder

功能

返回强类型的 DbCommandBuilder 实例。

函数

DbCommandBuilder CreateCommandBuilder()

参数：无。
返回值

返回创建的命令构建器。

8.11.4.CreateConnection

功能

返回强类型的 DbConnection 实例。
函数
```
DbConnection CreateConnection()
```
参数：无。
返回值

返回创建的连接对象。

8.11.5.CreateDataAdapter

功能

返回强类型的 DbDataAdapter 实例。
函数
```
DbDataAdapter CreateDataAdapter()
```
参数：无。
返回值

返回创建的数据适配器。

8.11.6.CreateParameter

功能

返回强类型的 DbParameter 实例。
函数
```
DbParameter CreateParameter()
```
参数：无。
返回值

返回创建的参数对象。

8.11.7.CreateConnectionStringBuilder

功能

返回强类型的 DbConnectionStringBuilder 实例。

函数

DbConnectionStringBuilder CreateConnectionStringBuilder()

参数：无。
返回值

返回创建的连接字符串构建器。

8.11.8.GetService

功能

获取指定类型的服务对象。
函数
```
object GetService(Type serviceType)
```
参数

表 GetService 参数说明

名称描述

serviceType（输入）指定要获取的服务对象类型的对象。
返回值

serviceType 类型的服务对象；若不存在该类型的服务对象则为 null。

8.12.NuxsqlEventLog（事件日志工具）

8.12.1.Level

功能

级别（可读可写）
函数
```
LogLevel Level
```
参数：无。
返回值

返回/设置级别（可读可写）。

8.12.2.LogName

功能

设置/返回用于记录日志的文件名。
函数
```
String LogName
```
参数：无。
返回值

返回/设置记录名称。

8.12.3.EchoMessages

功能

设置/返回日志消息是否应回显到控制台。
函数
```
Boolean EchoMessages
```
参数：无。
返回值

返回/设置是否回显协议消息。

8.13.NuxsqlNoticeEventArgs（NOTICE 消息事件参数）

8.13.1.Notice

功能

通知信息。
函数
```
NuxsqlError Notice = null
```
参数：无。
返回值

返回提示消息。

8.14.NuxsqlNotificationEventArgs（NOTIFY 异步通知事件参数）

8.14.1.PID

功能

发送该通知的 UXDB 后端的进程 ID。
函数
```
int PID
```
参数：无。
返回值

返回/设置进程 ID。

8.14.2.Condition

功能

触发该通知的条件。
函数
```
string Condition
```
参数：无。
返回值

返回/设置错误发生的条件。

8.14.3.AdditionalInformation

功能

来自通知进程的附加信息（保留供将来使用，目前 UXDB 始终将其设为空字符串）。
函数
```
string AdditionalInformation
```
参数：无。
返回值

返回/设置附加信息。

8.15.NuxsqlRowUpdatedEventArgs（批量更新完成事件参数）

8.15.1.NuxsqlRowUpdatedEventArgs

功能

构造函数

函数

NuxsqlRowUpdatedEventArgs(DataRow dataRow, IDbCommand command, StatementType statementType, DataTableMapping tableMapping)

参数

表 NuxsqlRowUpdatedEventArgs 参数说明

名称	描述
dataRow（输入）	数据行。
command（输入）	命令对象。
statementType（输入）	语句类型。
tableMapping（输入）	表映射。

返回值

返回一个 NuxsqlRowUpdatedEventArgs 对象。

8.16.NuxsqlRowUpdatingEventArgs（批量更新中事件参数）

8.16.1.NuxsqlRowUpdatingEventArgs

功能

构造函数

函数

NuxsqlRowUpdatingEventArgs(DataRow dataRow, IDbCommand command, StatementType statementType, DataTableMapping tableMapping)

参数

表 NuxsqlRowUpdatingEventArgs 参数说明

名称	描述
dataRow（输入）	数据行。
command（输入）	命令对象。
statementType（输入）	语句类型。
tableMapping（输入）	表映射。

返回值

返回一个 NuxsqlRowUpdatingEventArgs 对象。

8.17.NuxsqlCopyIn（COPY FROM STDIN 批量导入）

8.17.1.NuxsqlCopyIn

功能

给定命令在调用 Start() 时执行，fromStream 中的全部数据将作为复制数据传入。

函数

NuxsqlCopyIn(string copyInQuery, NuxsqlConnection conn) : this(new NuxsqlCommand(copyInQuery, conn), conn)

参数

表 NuxsqlCopyIn 参数说明

名称描述

copyInQuery（输入） COPY 导入查询语句。

conn（输入）连接对象。
返回值

返回一个 NuxsqlCopyIn 对象。

8.17.2.NuxsqlCopyIn

功能

给定命令在调用 Start() 时执行。随后可将所请求 COPY IN 操作的数据写入 CopyData 流，并调用 End() 或 Cancel() 结束。

函数

NuxsqlCopyIn(NuxsqlCommand cmd, NuxsqlConnection conn)

参数

表 NuxsqlCopyIn 参数说明

名称描述

cmd（输入）命令对象。

conn（输入）连接对象。
返回值

返回一个 NuxsqlCopyIn 对象。

8.17.3.NuxsqlCopyIn

功能

给定命令在调用 Start() 时执行，fromStream 中的全部数据将作为复制数据传入。

函数

NuxsqlCopyIn(NuxsqlCommand cmd, NuxsqlConnection conn, Stream fromStream)

参数

表 NuxsqlCopyIn 参数说明

名称描述

cmd（输入）命令对象。

conn（输入）连接对象。

fromStream（输入）输入数据流。
返回值

返回一个 NuxsqlCopyIn 对象。

8.17.4.IsActive

功能

若连接当前被保留用于该操作，则返回 true。
函数
```
bool IsActive
```
参数：无。
返回值

返回/设置是否处于活动状态。

8.17.5.CopyStream

功能

由用户提供的流，或在调用 Start() 时生成的流。用户可向构造函数提供一个流，用于将从该流读取的全部数据传给服务器；否则调用 Start() 会将其设为一个可写的 NuxsqlCopyInStream，把写入其中的全部数据传给服务器。后一种情况下，该流仅在复制操作处于活动状态时可用，否则为 null。
函数
```
Stream CopyStream
```
参数：无。
返回值

返回 COPY 数据流。

8.17.6.IsBinary

功能

若该操作当前处于活动状态且为二进制格式，则返回 true。
函数
```
bool IsBinary
```
参数：无。
返回值

返回/设置是否二进制格式。

8.17.7.FieldIsBinary

功能

若该操作当前处于活动状态且指定位置的字段为二进制格式，则返回 true。
函数
```
bool FieldIsBinary(int fieldNumber)
```
参数

表 FieldIsBinary 参数说明

名称描述

fieldNumber（输入）字段序号（从 0 开始）。
返回值

返回是否指定字段是否为二进制格式。

8.17.8.FieldCount

功能

若该操作当前处于活动状态，则返回每行输入所期望的字段数，否则返回 -1。
函数
```
int FieldCount
```
参数：无。
返回值

返回/设置字段（列）数。

8.17.9.NuxsqlCommand

功能

用于执行本次复制操作的命令。
函数
```
NuxsqlCommand NuxsqlCommand
```
参数：无。
返回值

返回所属命令对象。

8.17.10.CopyBufferSize

功能

在 COPY IN 查询之前设置，用于定义从给定 CopyStream 读取时内部缓冲区的大小。
函数
```
int CopyBufferSize
```
参数：无。
返回值

返回 COPY 缓冲区大小。

8.17.11.Start

功能

创建时指定的命令以非查询方式执行。若创建时已设置 CopyStream，它将作为复制数据刷入服务器并立即结束操作；否则可使用 CopyStream 成员向服务器写入复制数据，并通过调用 End() 或 Cancel() 结束操作。
函数
```
void Start()
```
参数：无。
返回值

无返回值。

8.17.12.End

功能

在向 CopyStream 写入全部数据后调用，以成功完成本次复制操作。
函数
```
void End()
```
参数：无。
返回值

无返回值。

8.17.13.Cancel

功能

撤销一个已启动的复制操作。该操作将以给定的错误消息失败。若当前操作未处于活动状态，则不执行任何操作。
函数
```
void Cancel(string message)
```
参数

表 Cancel 参数说明

名称描述

message（输入）提示消息。
返回值

无返回值。

8.18.NuxsqlCopyOut（COPY TO STDOUT 批量导出）

8.18.1.NuxsqlCopyOut

功能

给定命令在调用 Start() 时执行，所请求的全部复制数据将立即写入 toStream。

函数

NuxsqlCopyOut(string copyOutQuery, NuxsqlConnection conn) : this(new NuxsqlCommand(copyOutQuery, conn), conn)

参数

表 NuxsqlCopyOut 参数说明

名称描述

copyOutQuery（输入） COPY 导出查询语句。

conn（输入）连接对象。
返回值

返回一个 NuxsqlCopyOut 对象。

8.18.2.NuxsqlCopyOut

功能

给定命令在调用 Start() 时执行，之后 CopyStream 按查询请求提供来自数据库的数据。

函数

NuxsqlCopyOut(NuxsqlCommand cmd, NuxsqlConnection conn)

参数

表 NuxsqlCopyOut 参数说明

名称描述

cmd（输入）命令对象。

conn（输入）连接对象。
返回值

返回一个 NuxsqlCopyOut 对象。

8.18.3.NuxsqlCopyOut

功能

给定命令在调用 Start() 时执行，所请求的全部复制数据将立即写入 toStream。

函数

NuxsqlCopyOut(NuxsqlCommand cmd, NuxsqlConnection conn, Stream toStream)

参数

表 NuxsqlCopyOut 参数说明

名称描述

cmd（输入）命令对象。

conn（输入）连接对象。

toStream（输入）输出数据流。
返回值

返回一个 NuxsqlCopyOut 对象。

8.18.4.IsActive

功能

若连接当前被保留用于该操作，则返回 true。
函数
```
bool IsActive
```
参数：无。
返回值

返回/设置是否处于活动状态。

8.18.5.CopyStream

功能

由用户提供的流，或在调用 Start() 时生成的流。
函数
```
Stream CopyStream
```
参数：无。
返回值

返回 COPY 数据流。

8.18.6.NuxsqlCommand

功能

用于执行本次复制操作的命令。
函数
```
NuxsqlCommand NuxsqlCommand
```
参数：无。
返回值

返回所属命令对象。

8.18.7.IsBinary

功能

若该操作当前处于活动状态且为二进制格式，则返回 true。
函数
```
bool IsBinary
```
参数：无。
返回值

返回/设置是否二进制格式。

8.18.8.FieldIsBinary

功能

若该操作当前处于活动状态且指定位置的字段为二进制格式，则返回 true。
函数
```
bool FieldIsBinary(int fieldNumber)
```
参数

表 FieldIsBinary 参数说明

名称描述

fieldNumber（输入）字段序号（从 0 开始）。
返回值

返回是否指定字段是否为二进制格式。

8.18.9.FieldCount

功能

若该操作当前处于活动状态，则返回字段数，否则返回 -1。
函数
```
int FieldCount
```
参数：无。
返回值

返回/设置字段（列）数。

8.18.10.Start

功能

创建时指定的命令以非查询方式执行。若创建时已设置 CopyStream，来自服务器的全部复制数据将写入其中，并立即结束操作；否则可使用 CopyStream 成员从服务器读取复制数据，直至无更多数据可用。
函数
```
void Start()
```
参数：无。
返回值

无返回值。

8.18.11.Read

功能

使用生成的 CopyStream 之外的更快速替代方式。
函数
```
byte[] Read
```
参数：无。
返回值

返回/设置读取。

8.18.12.End

功能

一次性刷新生成的 CopyStream。实际效果是读取并丢弃服务器端剩余的全部复制数据。
函数
```
void End()
```
参数：无。
返回值

无返回值。

8.19.NuxsqlCopyFormat（COPY 数据格式描述）

8.19.1.IsBinary

功能

若该操作当前处于活动状态且为二进制格式，则返回 true。
函数
```
bool IsBinary
```
参数：无。
返回值

返回/设置是否二进制格式。

8.19.2.FieldIsBinary

功能

若该操作当前处于活动状态且指定位置的字段为二进制格式，则返回 true。
函数
```
bool FieldIsBinary(int fieldNumber)
```
参数

表 FieldIsBinary 参数说明

名称描述

fieldNumber（输入）字段序号（从 0 开始）。
返回值

返回是否指定字段是否为二进制格式。

8.19.3.FieldCount

功能

若该操作当前处于活动状态，则返回字段数，否则返回 -1。
函数
```
int FieldCount
```
参数：无。
返回值

返回/设置字段（列）数。

8.20.NuxsqlCopySerializer（COPY 数据序列化器）

8.20.1.DEFAULT_DELIMITER

功能

默认分隔符。
函数
```
String DEFAULT_DELIMITER = "\t"
```
参数：无。
返回值

返回默认分隔符常量。

8.20.2.DEFAULT_SEPARATOR

功能

默认分隔符。
函数
```
String DEFAULT_SEPARATOR = "\n"
```
参数：无。
返回值

返回默认分隔符常量。

8.20.3.DEFAULT_NULL

功能

默认 null 表示。
函数
```
String DEFAULT_NULL = "\\N"
```
参数：无。
返回值

返回默认值空值常量。

8.20.4.DEFAULT_ESCAPE

功能

默认转义符。
函数
```
String DEFAULT_ESCAPE = "\\"
```
参数：无。
返回值

返回默认值转义常量。

8.20.5.DEFAULT_QUOTE

功能

默认引号。
函数
```
String DEFAULT_QUOTE = "\""
```
参数：无。
返回值

返回默认引用符常量。

8.20.6.DEFAULT_BUFFER_SIZE

功能

默认缓冲区大小。
函数
```
int DEFAULT_BUFFER_SIZE = 8192
```
参数：无。
返回值

返回默认值缓冲区大小常量。

8.20.7.NuxsqlCopySerializer

功能

构造函数。

函数

NuxsqlCopySerializer(NuxsqlConnection conn)

参数

表 NuxsqlCopySerializer 参数说明

名称描述

conn（输入）连接对象。
返回值

返回一个 NuxsqlCopySerializer 对象。

8.20.8.IsActive

功能

报告序列化器是否处于活动状态。
函数
```
bool IsActive
```
参数：无。
返回值

返回/设置是否处于活动状态。

8.20.9.ToStream

功能

输出为流。
函数
```
Stream ToStream
```
参数：无。
返回值

返回/设置转换为流。

8.20.10.Delimiter

功能

分隔符。
函数
```
String Delimiter
```
参数：无。
返回值

返回分隔符。

8.20.11.Separator

功能

分隔符。
函数
```
String Separator
```
参数：无。
返回值

返回分隔符。

8.20.12.Escape

功能

转义符。
函数
```
String Escape
```
参数：无。
返回值

返回转义。

8.20.13.Null

功能

空值。
函数
```
String Null
```
参数：无。
返回值

返回空值。

8.20.14.BufferSize

功能

缓冲区大小。
函数
```
Int32 BufferSize
```
参数：无。
返回值

返回缓冲区大小。

8.20.15.Flush

功能

刷新缓冲区。
函数
```
void Flush()
```
参数：无。
返回值

无返回值。

8.20.16.FlushRows

功能

刷新行。
函数
```
void FlushRows()
```
参数：无。
返回值

无返回值。

8.20.17.FlushFields

功能

刷新字段。
函数
```
void FlushFields()
```
参数：无。
返回值

无返回值。

8.20.18.Close

功能

关闭序列化器。
函数
```
void Close()
```
参数：无。
返回值

无返回值。

8.20.19.EndRow

功能

结束一行。
函数
```
void EndRow()
```
参数：无。
返回值

无返回值。

8.20.20.AddNull

功能

添加 null 值。
函数
```
void AddNull()
```
参数：无。
返回值

无返回值。

8.20.21.AddString

功能

添加字符串。
函数
```
void AddString(String fieldValue)
```
参数

表 AddString 参数说明

名称描述

fieldValue（输入）字段值。
返回值

无返回值。

8.20.22.AddInt32

功能

添加 Int32 值。
函数
```
void AddInt32(Int32 fieldValue)
```
参数

表 AddInt32 参数说明

名称描述

fieldValue（输入）字段值。
返回值

无返回值。

8.20.23.AddInt64

功能

添加 Int64 值。
函数
```
void AddInt64(Int64 fieldValue)
```
参数

表 AddInt64 参数说明

名称描述

fieldValue（输入）字段值。
返回值

无返回值。

8.20.24.AddNumber

功能

添加数值。
函数
```
void AddNumber(double fieldValue)
```
参数

表 AddNumber 参数说明

名称描述

fieldValue（输入）字段值。
返回值

无返回值。

8.20.25.AddBool

功能

添加 bool 值。
函数
```
void AddBool(bool fieldValue)
```
参数

表 AddBool 参数说明

名称描述

fieldValue（输入）字段值。
返回值

无返回值。

8.20.26.AddDateTime

功能

添加 DateTime 值。
函数
```
void AddDateTime(DateTime fieldValue)
```
参数

表 AddDateTime 参数说明

名称描述

fieldValue（输入）字段值。
返回值

无返回值。

8.21.NuxsqlDbType（UXDB 数据类型枚举）

8.21.1.Array

功能

对应 UXDB 的 “array” 类型，即另一种类型的变长多维数组。该值必须通过按位或与 NuxsqlDbType 中的另一个值组合使用（例如 NuxsqlDbType.Array | NuxsqlDbType.Integer）。
函数
```
枚举取值 int.MinValue
```
参数：无。
返回值

取值为 int.MinValue。

8.21.2.Bigint

功能

对应 UXDB 的 8 字节 “bigint” 类型。
函数
```
枚举取值 1
```
参数：无。
返回值

取值为 1。

8.21.3.Boolean

功能

布尔
参数：无。
返回值

表示布尔。

8.21.4.Box

功能

矩形
参数：无。
返回值

表示矩形。

8.21.5.Bytea

功能

字节数组
参数：无。
返回值

表示字节数组。

8.21.6.Circle

功能

圆
参数：无。
返回值

表示圆。

8.21.7.Char

功能

字符
参数：无。
返回值

表示字符。

8.21.8.Date

功能

日期
参数：无。
返回值

表示日期。

8.21.9.Double

功能

双精度浮点
参数：无。
返回值

表示双精度浮点。

8.21.10.Integer

功能

32 位整型
参数：无。
返回值

表示32 位整型。

8.21.11.Line

功能

直线
参数：无。
返回值

表示直线。

8.21.12.LSeg

功能

线段
参数：无。
返回值

表示线段。

8.21.13.Money

功能

货币
参数：无。
返回值

表示货币。

8.21.14.Numeric

功能

定点数
参数：无。
返回值

表示定点数。

8.21.15.Path

功能

路径
参数：无。
返回值

表示路径。

8.21.16.Point

功能

点
参数：无。
返回值

表示点。

8.21.17.Polygon

功能

多边形
参数：无。
返回值

表示多边形。

8.21.18.Real

功能

单精度浮点
参数：无。
返回值

表示单精度浮点。

8.21.19.Smallint

功能

16 位整型
参数：无。
返回值

表示16 位整型。

8.21.20.Text

功能

文本
参数：无。
返回值

表示文本。

8.21.21.Time

功能

时间
参数：无。
返回值

表示时间。

8.21.22.Timestamp

功能

时间戳
参数：无。
返回值

表示时间戳。

8.21.23.Varchar

功能

变长字符串
参数：无。
返回值

表示变长字符串。

8.21.24.Refcursor

功能

游标引用
参数：无。
返回值

表示游标引用。

8.21.25.Inet

功能

网络地址
参数：无。
返回值

表示网络地址。

8.21.26.Bit

功能

位串
参数：无。
返回值

表示位串。

8.21.27.TimestampTZ

功能

带时区时间戳
参数：无。
返回值

表示带时区时间戳。

8.21.28.Uuid

功能

UUID
参数：无。
返回值

表示UUID。

8.21.29.Xml

功能

XML
参数：无。
返回值

表示XML。

8.21.30.Oidvector

功能

OID 向量
参数：无。
返回值

表示OID 向量。

8.21.31.Interval

功能

时间间隔
参数：无。
返回值

表示时间间隔。

8.21.32.TimeTZ

功能

带时区时间
参数：无。
返回值

表示带时区时间。

8.21.33.Name

功能

名称
参数：无。
返回值

表示名称。

8.21.34.Abstime

功能

绝对时间
参数：无。
返回值

表示绝对时间。

8.21.35.MacAddr

功能

MAC 地址
参数：无。
返回值

表示MAC 地址。

8.21.36.Json

功能

JSON
参数：无。
返回值

表示JSON。

8.21.37.Jsonb

功能

二进制 JSON
参数：无。
返回值

表示二进制 JSON。

8.21.38.Hstore

功能

键值对
参数：无。
返回值

表示键值对。

8.22.NuxsqlDate（日期类型）

8.22.1.MaxYear

功能

最大年常量
函数
```
int MaxYear = 5874897
```
参数：无。
返回值

返回最大年常量。

8.22.2.MinYear

功能

最小年常量
函数
```
int MinYear = -4714
```
参数：无。
返回值

返回最小年常量。

8.22.3.Epoch

功能

纪元

函数

NuxsqlDate Epoch = new NuxsqlDate(1970, 1, 1)

参数：无。
返回值

返回纪元。

8.22.4.MaxCalculableValue

功能

最大可计算值

函数

NuxsqlDate MaxCalculableValue = new NuxsqlDate(MaxYear, 12, 31)

参数：无。
返回值

返回最大可计算值。

8.22.5.MinCalculableValue

功能

最小可计算值

函数

NuxsqlDate MinCalculableValue = new NuxsqlDate(MinYear, 11, 24)

参数：无。
返回值

返回最小可计算值。

8.22.6.Era

功能

纪元
函数
```
NuxsqlDate Era = new NuxsqlDate(0)
```
参数：无。
返回值

返回纪元。

8.22.7.Now

功能

当前时间
函数
```
NuxsqlDate Now
```
参数：无。
返回值

返回/设置当前时间。

8.22.8.Today

功能

获取今天
函数
```
NuxsqlDate Today
```
参数：无。
返回值

返回今天。

8.22.9.Yesterday

功能

昨天
函数
```
NuxsqlDate Yesterday
```
参数：无。
返回值

返回/设置昨天。

8.22.10.Tomorrow

功能

明天
函数
```
NuxsqlDate Tomorrow
```
参数：无。
返回值

返回/设置明天。

8.22.11.Parse

功能

解析
函数
```
NuxsqlDate Parse(string str)
```
参数

表 Parse 参数说明

名称描述

str（输入）要解析的字符串。
返回值

返回解析得到的对象。

8.22.12.TryParse

功能

尝试解析

函数

bool TryParse(string str, out NuxsqlDate date)

参数

表 TryParse 参数说明

名称描述

str（输入）要解析的字符串。

date（输出）解析得到的日期对象。
返回值

返回是否解析成功。

8.22.13.NuxsqlDate

功能

构造函数
函数
```
NuxsqlDate(int days)
```
参数

表 NuxsqlDate 参数说明

名称描述

days（输入）天数。
返回值

返回一个 NuxsqlDate 对象。

8.22.14.NuxsqlDate

功能

构造函数

函数

NuxsqlDate(DateTime dateTime) : this((int) (dateTime.Ticks/TimeSpan.TicksPerDay))

参数

表 NuxsqlDate 参数说明

名称描述

dateTime（输入）日期时间对象。
返回值

返回一个 NuxsqlDate 对象。

8.22.15.NuxsqlDate

功能

构造函数
函数
```
NuxsqlDate(NuxsqlDate copyFrom)
```
参数

表 NuxsqlDate 参数说明

名称描述

copyFrom（输入）要复制的对象。
返回值

返回一个 NuxsqlDate 对象。

8.22.16.NuxsqlDate

功能

构造函数

函数

NuxsqlDate(int year, int month, int day)

参数

表 NuxsqlDate 参数说明

名称描述

year（输入）年。

month（输入）月。

day（输入）日。
返回值

返回一个 NuxsqlDate 对象。

8.22.17.DayOfYear

功能

一年中的第几天
函数
```
int DayOfYear
```
参数：无。
返回值

返回/设置一年中的第几天。

8.22.18.Year

功能

年
函数
```
int Year
```
参数：无。
返回值

返回/设置年。

8.22.19.Month

功能

获取月
函数
```
int Month
```
参数：无。
返回值

返回月。

8.22.20.Day

功能

获取日
函数
```
int Day
```
参数：无。
返回值

返回日。

8.22.21.DayOfWeek

功能

星期
函数
```
DayOfWeek DayOfWeek
```
参数：无。
返回值

返回/设置星期。

8.22.22.IsLeapYear

功能

判断是否闰年
函数
```
bool IsLeapYear
```
参数：无。
返回值

返回/设置判断是否闰年。

8.22.23.AddDays

功能

添加天
函数
```
NuxsqlDate AddDays(int days)
```
参数

表 AddDays 参数说明

名称描述

days（输入）天数。
返回值

返回添加指定天数后的结果。

8.22.24.AddYears

功能

添加年
函数
```
NuxsqlDate AddYears(int years)
```
参数

表 AddYears 参数说明

名称描述

years（输入）年数。
返回值

返回添加指定年数后的结果。

8.22.25.AddMonths

功能

添加月
函数
```
NuxsqlDate AddMonths(int months)
```
参数

表 AddMonths 参数说明

名称描述

months（输入）月数。
返回值

返回添加指定月数后的结果。

8.22.26.Add

功能

添加

函数

NuxsqlDate Add(NuxsqlInterval interval)

参数

表 Add 参数说明

名称描述

interval（输入）时间间隔对象。
返回值

返回添加后的结果。

8.22.27.Compare

功能

比较

函数

int Compare(NuxsqlDate x, NuxsqlDate y)

参数

表 Compare 参数说明

名称描述

x（输入）第一个比较对象。

y（输入）第二个比较对象。
返回值

返回比较结果（小于、等于或大于）。

8.22.28.Compare

功能

比较
函数
```
int Compare(object x, object y)
```
参数

表 Compare 参数说明

名称描述

x（输入）第一个比较对象。

y（输入）第二个比较对象。
返回值

返回比较结果（小于、等于或大于）。

8.22.29.Equals

功能

判断是否与另一对象相等
函数
```
bool Equals(NuxsqlDate other)
```
参数

表 Equals 参数说明

名称描述

other（输入）另一个比较对象。
返回值

返回两个对象是否相等。

8.22.30.Equals

功能

判断是否与另一对象相等
函数
```
bool Equals(object obj)
```
参数

表 Equals 参数说明

名称描述

obj（输入）另一个对象。
返回值

返回两个对象是否相等。

8.22.31.CompareTo

功能

与另一对象比较大小
函数
```
int CompareTo(NuxsqlDate other)
```
参数

表 CompareTo 参数说明

名称描述

other（输入）另一个比较对象。
返回值

返回比较结果（小于、等于或大于）。

8.22.32.CompareTo

功能

与另一对象比较大小
函数
```
int CompareTo(object obj)
```
参数

表 CompareTo 参数说明

名称描述

obj（输入）另一个对象。
返回值

返回比较结果（小于、等于或大于）。

8.22.33.GetHashCode

功能

获取对象的哈希码
函数
```
int GetHashCode()
```
参数：无。
返回值

返回对象的哈希码。

8.22.34.ToString

功能

转换为字符串
函数
```
string ToString()
```
参数：无。
返回值

返回对象的字符串表示。

8.22.35.DateTime

功能

日期时间

函数

explicit operator DateTime(NuxsqlDate date)

参数

表 DateTime 参数说明

名称描述

date（输入）日期对象。
返回值

返回日期时间。

8.22.36.NuxsqlDate

功能

构造函数

函数

explicit operator NuxsqlDate(DateTime date)

参数

表 NuxsqlDate 参数说明

名称描述

date（输入）日期对象。
返回值

返回一个 NuxsqlDate 对象。

8.23.NuxsqlTime（时间类型）

8.23.1.AllBalls

功能

全部球体

函数

NuxsqlTime AllBalls = new NuxsqlTime(0)

参数：无。
返回值

返回全部球体。

8.23.2.Now

功能

当前时间
函数
```
NuxsqlTime Now
```
参数：无。
返回值

返回/设置当前时间。

8.23.3.NuxsqlTime

功能

构造函数
函数
```
NuxsqlTime(long ticks)
```
参数

表 NuxsqlTime 参数说明

名称描述

ticks（输入）时钟周期数。
返回值

返回一个 NuxsqlTime 对象。

8.23.4.NuxsqlTime

功能

构造函数
函数
```
NuxsqlTime(TimeSpan time)
```
参数

表 NuxsqlTime 参数说明

名称描述

time（输入）时间对象。
返回值

返回一个 NuxsqlTime 对象。

8.23.5.NuxsqlTime

功能

构造函数
函数
```
NuxsqlTime(NuxsqlInterval time)
```
参数

表 NuxsqlTime 参数说明

名称描述

time（输入）时间对象。
返回值

返回一个 NuxsqlTime 对象。

8.23.6.NuxsqlTime

功能

构造函数
函数
```
NuxsqlTime(NuxsqlTime copyFrom)
```
参数

表 NuxsqlTime 参数说明

名称描述

copyFrom（输入）要复制的对象。
返回值

返回一个 NuxsqlTime 对象。

8.23.7.NuxsqlTime

功能

构造函数

函数

NuxsqlTime(int hours, int minutes, int seconds)

参数

表 NuxsqlTime 参数说明

名称描述

hours（输入）小时。

minutes（输入）分钟。

seconds（输入）秒。
返回值

返回一个 NuxsqlTime 对象。

8.23.8.NuxsqlTime

功能

构造函数

函数

NuxsqlTime(int hours, int minutes, int seconds, int microseconds)

参数

表 NuxsqlTime 参数说明

名称	描述
hours（输入）	小时。
minutes（输入）	分钟。
seconds（输入）	秒。
microseconds（输入）	微秒。

返回值

返回一个 NuxsqlTime 对象。

8.23.9.NuxsqlTime

功能

构造函数

函数

NuxsqlTime(int hours, int minutes, decimal seconds) : this( hours*NuxsqlInterval.TicksPerHour + minutes*NuxsqlInterval.TicksPerMinute + (long) (seconds*NuxsqlInterval.TicksPerSecond))

参数

表 NuxsqlTime 参数说明

名称描述

hours（输入）小时。

minutes（输入）分钟。

seconds（输入）秒。
返回值

返回一个 NuxsqlTime 对象。

8.23.10.NuxsqlTime

功能

构造函数

函数

NuxsqlTime(int hours, int minutes, double seconds) : this(hours, minutes, (decimal) seconds)

参数

表 NuxsqlTime 参数说明

名称描述

hours（输入）小时。

minutes（输入）分钟。

seconds（输入）秒。
返回值

返回一个 NuxsqlTime 对象。

8.23.11.Ticks

功能

实例中包含的计时周期总数（100 纳秒单位）。这是 NuxsqlTime 类型的分辨率。UXDB interval 类型的默认分辨率为 1µs = 1,000 ns，也可能更小，具体如下：time(0) 分辨率为 1s（1 秒）；time(1) 分辨率为 100ms = 0.1s（100 毫秒）；time(2) 分辨率为 10ms = 0.01s（10 毫秒）；time(3) 分辨率为 1ms = 0.001s（1 毫秒）；time(4) 分辨率为 100µs = 0.0001s（100 微秒）；time(5) 分辨率为 10µs = 0.00001s（10 微秒）；time(6) 或 interval 分辨率为 1µs = 0.000001s（1 微秒）。因此，若应用程序看重 100 纳秒的分辨率，UXDB 的 time 将无法满足需求。不过在多数情况下，time 的分辨率已足够。NuxsqlTime 始终足以处理任意 time 值的分辨率，写入数据库时会按所用分辨率进行舍入。即实例中的计时周期数。
函数
```
long Ticks
```
参数：无。
返回值

实例中的计时周期数。

8.23.12.Microseconds

功能

获取实例中保存的整数微秒数。取值范围为 [0, 999999] 的整数。
函数
```
int Microseconds
```
参数：无。
返回值

[0, 999999] 范围内的整数。

8.23.13.Milliseconds

功能

获取实例中保存的整数毫秒数。取值范围为 [0, 999] 的整数。
函数
```
int Milliseconds
```
参数：无。
返回值

[0, 999] 范围内的整数。

8.23.14.Seconds

功能

获取实例中保存的整数秒数。取值范围为 [0, 59] 的整数。
函数
```
int Seconds
```
参数：无。
返回值

[0, 59] 范围内的整数。

8.23.15.Minutes

功能

获取实例中保存的整数分钟数。取值范围为 [0, 59] 的整数。
函数
```
int Minutes
```
参数：无。
返回值

[0, 59] 范围内的整数。

8.23.16.Hours

功能

获取实例中保存的整数小时数。注意：为兼容往返转换，可存储 24:00:00 这一时间值；对该值做任何计算都会将其规范化为 00:00:00。
函数
```
int Hours
```
参数：无。
返回值

返回/设置小时。

8.23.17.Normalize

功能

规范化该时间；若为 24:00:00，则转换为 00:00:00。
函数
```
NuxsqlTime Normalize()
```
参数：无。
返回值

规范化后的该时间值。

8.23.18.Equals

功能

判断是否与另一对象相等
函数
```
bool Equals(NuxsqlTime other)
```
参数

表 Equals 参数说明

名称描述

other（输入）另一个比较对象。
返回值

返回两个对象是否相等。

8.23.19.Equals

功能

判断是否与另一对象相等
函数
```
bool Equals(object obj)
```
参数

表 Equals 参数说明

名称描述

obj（输入）另一个对象。
返回值

返回两个对象是否相等。

8.23.20.GetHashCode

功能

获取对象的哈希码
函数
```
int GetHashCode()
```
参数：无。
返回值

返回对象的哈希码。

8.23.21.ToString

功能

转换为字符串
函数
```
string ToString()
```
参数：无。
返回值

返回对象的字符串表示。

8.23.22.Parse

功能

解析
函数
```
NuxsqlTime Parse(string str)
```
参数

表 Parse 参数说明

名称描述

str（输入）要解析的字符串。
返回值

返回解析得到的对象。

8.23.23.TryParse

功能

尝试解析

函数

bool TryParse(string str, out NuxsqlTime time)

参数

表 TryParse 参数说明

名称描述

str（输入）要解析的字符串。

time（输出）解析得到的时间对象。
返回值

返回是否解析成功。

8.23.24.CompareTo

功能

与另一对象比较大小
函数
```
int CompareTo(NuxsqlTime other)
```
参数

表 CompareTo 参数说明

名称描述

other（输入）另一个比较对象。
返回值

返回比较结果（小于、等于或大于）。

8.23.25.CompareTo

功能

与另一对象比较大小
函数
```
int CompareTo(object obj)
```
参数

表 CompareTo 参数说明

名称描述

obj（输入）另一个对象。
返回值

返回比较结果（小于、等于或大于）。

8.23.26.Compare

功能

比较

函数

int Compare(NuxsqlTime x, NuxsqlTime y)

参数

表 Compare 参数说明

名称描述

x（输入）第一个比较对象。

y（输入）第二个比较对象。
返回值

返回比较结果（小于、等于或大于）。

8.23.27.Compare

功能

比较
函数
```
int Compare(object x, object y)
```
参数

表 Compare 参数说明

名称描述

x（输入）第一个比较对象。

y（输入）第二个比较对象。
返回值

返回比较结果（小于、等于或大于）。

8.23.28.NuxsqlInterval

功能

UXDB时间间隔

函数

explicit operator NuxsqlInterval(NuxsqlTime time)

参数

表 NuxsqlInterval 参数说明

名称描述

time（输入）时间对象。
返回值

返回UXDB时间间隔。

8.23.29.NuxsqlTime

功能

构造函数

函数

explicit operator NuxsqlTime(NuxsqlInterval interval)

参数

表 NuxsqlTime 参数说明

名称描述

interval（输入）时间间隔对象。
返回值

返回一个 NuxsqlTime 对象。

8.23.30.TimeSpan

功能

时间跨度

函数

explicit operator TimeSpan(NuxsqlTime time)

参数

表 TimeSpan 参数说明

名称描述

time（输入）时间对象。
返回值

返回时间跨度。

8.23.31.DateTime

功能

日期时间

函数

explicit operator DateTime(NuxsqlTime time)

参数

表 DateTime 参数说明

名称描述

time（输入）时间对象。
返回值

返回日期时间。

8.23.32.NuxsqlTime

功能

构造函数

函数

explicit operator NuxsqlTime(TimeSpan interval)

参数

表 NuxsqlTime 参数说明

名称描述

interval（输入）时间间隔对象。
返回值

返回一个 NuxsqlTime 对象。

8.23.33.AddTicks

功能

添加时钟周期
函数
```
NuxsqlTime AddTicks(long ticksAdded)
```
参数

表 AddTicks 参数说明

名称描述

ticksAdded（输入）要添加的时钟周期数。
返回值

返回添加指定时钟周期数后的结果。

8.23.34.Add

功能

添加

函数

NuxsqlTime Add(NuxsqlInterval interval)

参数

表 Add 参数说明

名称描述

interval（输入）时间间隔对象。
返回值

返回添加后的结果。

8.23.35.Subtract

功能

减去

函数

NuxsqlTime Subtract(NuxsqlInterval interval)

参数

表 Subtract 参数说明

名称描述

interval（输入）时间间隔对象。
返回值

返回相减后的结果。

8.23.36.Subtract

功能

减去

函数

NuxsqlInterval Subtract(NuxsqlTime earlier)

参数

表 Subtract 参数说明

名称描述

earlier（输入）较早的时间对象。
返回值

返回相减后的结果。

8.23.37.AtTimeZone

功能

转换到指定时区

函数

NuxsqlTimeTZ AtTimeZone(NuxsqlTimeZone timeZone)

参数

表 AtTimeZone 参数说明

名称描述

timeZone（输入）时区对象。
返回值

返回转换到指定时区后的结果。

8.24.NuxsqlTimeTZ（带时区的时间类型）

8.24.1.AllBalls

功能

全部球体

函数

NuxsqlTimeTZ AllBalls = new NuxsqlTimeTZ(NuxsqlTime.AllBalls, NuxsqlTimeZone.UTC)

参数：无。
返回值

返回全部球体。

8.24.2.Now

功能

当前时间
函数
```
NuxsqlTimeTZ Now
```
参数：无。
返回值

返回/设置当前时间。

8.24.3.LocalMidnight

功能

本地零点

函数

NuxsqlTimeTZ LocalMidnight(NuxsqlDate date)

参数

表 LocalMidnight 参数说明

名称描述

date（输入）日期对象。
返回值

返回本地零点。

8.24.4.NuxsqlTimeTZ

功能

构造函数

函数

NuxsqlTimeTZ(NuxsqlTime localTime, NuxsqlTimeZone timeZone)

参数

表 NuxsqlTimeTZ 参数说明

名称描述

localTime（输入）本地时间。

timeZone（输入）时区对象。
返回值

返回一个 NuxsqlTimeTZ 对象。

8.24.5.NuxsqlTimeTZ

功能

构造函数
函数
```
NuxsqlTimeTZ(NuxsqlTime localTime)
```
参数

表 NuxsqlTimeTZ 参数说明

名称描述

localTime（输入）本地时间。
返回值

返回一个 NuxsqlTimeTZ 对象。

8.24.6.NuxsqlTimeTZ

功能

构造函数

函数

NuxsqlTimeTZ(long ticks) : this(new NuxsqlTime(ticks))

参数

表 NuxsqlTimeTZ 参数说明

名称描述

ticks（输入）时钟周期数。
返回值

返回一个 NuxsqlTimeTZ 对象。

8.24.7.NuxsqlTimeTZ

功能

构造函数

函数

NuxsqlTimeTZ(TimeSpan time) : this(new NuxsqlTime(time))

参数

表 NuxsqlTimeTZ 参数说明

名称描述

time（输入）时间对象。
返回值

返回一个 NuxsqlTimeTZ 对象。

8.24.8.NuxsqlTimeTZ

功能

构造函数

函数

NuxsqlTimeTZ(NuxsqlInterval time) : this(new NuxsqlTime(time))

参数

表 NuxsqlTimeTZ 参数说明

名称描述

time（输入）时间对象。
返回值

返回一个 NuxsqlTimeTZ 对象。

8.24.9.NuxsqlTimeTZ

功能

构造函数
函数
```
NuxsqlTimeTZ(NuxsqlTimeTZ copyFrom)
```
参数

表 NuxsqlTimeTZ 参数说明

名称描述

copyFrom（输入）要复制的对象。
返回值

返回一个 NuxsqlTimeTZ 对象。

8.24.10.NuxsqlTimeTZ

功能

构造函数

函数

NuxsqlTimeTZ(int hours, int minutes, int seconds) : this(new NuxsqlTime(hours, minutes, seconds))

参数

表 NuxsqlTimeTZ 参数说明

名称描述

hours（输入）小时。

minutes（输入）分钟。

seconds（输入）秒。
返回值

返回一个 NuxsqlTimeTZ 对象。

8.24.11.NuxsqlTimeTZ

功能

构造函数

函数

NuxsqlTimeTZ(int hours, int minutes, int seconds, int microseconds) : this(new NuxsqlTime(hours, minutes, seconds, microseconds))

参数

表 NuxsqlTimeTZ 参数说明

名称	描述
hours（输入）	小时。
minutes（输入）	分钟。
seconds（输入）	秒。
microseconds（输入）	微秒。

返回值

返回一个 NuxsqlTimeTZ 对象。

8.24.12.NuxsqlTimeTZ

功能

构造函数

函数

NuxsqlTimeTZ(int hours, int minutes, decimal seconds) : this(new NuxsqlTime(hours, minutes, seconds))

参数

表 NuxsqlTimeTZ 参数说明

名称描述

hours（输入）小时。

minutes（输入）分钟。

seconds（输入）秒。
返回值

返回一个 NuxsqlTimeTZ 对象。

8.24.13.NuxsqlTimeTZ

功能

构造函数

函数

NuxsqlTimeTZ(int hours, int minutes, double seconds) : this(new NuxsqlTime(hours, minutes, seconds))

参数

表 NuxsqlTimeTZ 参数说明

名称描述

hours（输入）小时。

minutes（输入）分钟。

seconds（输入）秒。
返回值

返回一个 NuxsqlTimeTZ 对象。

8.24.14.NuxsqlTimeTZ

功能

构造函数

函数

NuxsqlTimeTZ(long ticks, NuxsqlTimeZone timeZone) : this(new NuxsqlTime(ticks), timeZone)

参数

表 NuxsqlTimeTZ 参数说明

名称描述

ticks（输入）时钟周期数。

timeZone（输入）时区对象。
返回值

返回一个 NuxsqlTimeTZ 对象。

8.24.15.NuxsqlTimeTZ

功能

构造函数

函数

NuxsqlTimeTZ(TimeSpan time, NuxsqlTimeZone timeZone) : this(new NuxsqlTime(time), timeZone)

参数

表 NuxsqlTimeTZ 参数说明

名称描述

time（输入）时间对象。

timeZone（输入）时区对象。
返回值

返回一个 NuxsqlTimeTZ 对象。

8.24.16.NuxsqlTimeTZ

功能

构造函数

函数

NuxsqlTimeTZ(NuxsqlInterval time, NuxsqlTimeZone timeZone) : this(new NuxsqlTime(time), timeZone)

参数

表 NuxsqlTimeTZ 参数说明

名称描述

time（输入）时间对象。

timeZone（输入）时区对象。
返回值

返回一个 NuxsqlTimeTZ 对象。

8.24.17.NuxsqlTimeTZ

功能

构造函数

函数

NuxsqlTimeTZ(int hours, int minutes, int seconds, NuxsqlTimeZone timeZone) : this(new NuxsqlTime(hours, minutes, seconds), timeZone)

参数

表 NuxsqlTimeTZ 参数说明

名称	描述
hours（输入）	小时。
minutes（输入）	分钟。
seconds（输入）	秒。
timeZone（输入）	时区对象。

返回值

返回一个 NuxsqlTimeTZ 对象。

8.24.18.NuxsqlTimeTZ

功能

构造函数

函数

NuxsqlTimeTZ(int hours, int minutes, int seconds, int microseconds, NuxsqlTimeZone timeZone) : this(new NuxsqlTime(hours, minutes, seconds, microseconds), timeZone)

参数

表 NuxsqlTimeTZ 参数说明

名称	描述
hours（输入）	小时。
minutes（输入）	分钟。
seconds（输入）	秒。
microseconds（输入）	微秒。
timeZone（输入）	时区对象。

返回值

返回一个 NuxsqlTimeTZ 对象。

8.24.19.NuxsqlTimeTZ

功能

构造函数

函数

NuxsqlTimeTZ(int hours, int minutes, decimal seconds, NuxsqlTimeZone timeZone) : this(new NuxsqlTime(hours, minutes, seconds), timeZone)

参数

表 NuxsqlTimeTZ 参数说明

名称	描述
hours（输入）	小时。
minutes（输入）	分钟。
seconds（输入）	秒。
timeZone（输入）	时区对象。

返回值

返回一个 NuxsqlTimeTZ 对象。

8.24.20.NuxsqlTimeTZ

功能

构造函数

函数

NuxsqlTimeTZ(int hours, int minutes, double seconds, NuxsqlTimeZone timeZone) : this(new NuxsqlTime(hours, minutes, seconds), timeZone)

参数

表 NuxsqlTimeTZ 参数说明

名称	描述
hours（输入）	小时。
minutes（输入）	分钟。
seconds（输入）	秒。
timeZone（输入）	时区对象。

返回值

返回一个 NuxsqlTimeTZ 对象。

8.24.21.ToString

功能

转换为字符串
函数
```
string ToString()
```
参数：无。
返回值

返回对象的字符串表示。

8.24.22.Parse

功能

解析
函数
```
NuxsqlTimeTZ Parse(string str)
```
参数

表 Parse 参数说明

名称描述

str（输入）要解析的字符串。
返回值

返回解析得到的对象。

8.24.23.LocalTime

功能

获取本地时间
函数
```
NuxsqlTime LocalTime
```
参数：无。
返回值

返回本地时间。

8.24.24.TimeZone

功能

获取时区
函数
```
NuxsqlTimeZone TimeZone
```
参数：无。
返回值

返回时区。

8.24.25.UTCTime

功能

UTC时间
函数
```
NuxsqlTime UTCTime
```
参数：无。
返回值

返回/设置UTC时间。

8.24.26.AtTimeZone

功能

转换到指定时区

函数

NuxsqlTimeTZ AtTimeZone(NuxsqlTimeZone timeZone)

参数

表 AtTimeZone 参数说明

名称描述

timeZone（输入）时区对象。
返回值

返回转换到指定时区后的结果。

8.24.27.Ticks

功能

获取时钟周期
函数
```
long Ticks
```
参数：无。
返回值

返回时钟周期。

8.24.28.Microseconds

功能

获取实例中保存的整数微秒数。取值范围为 [0, 999999] 的整数。
函数
```
int Microseconds
```
参数：无。
返回值

[0, 999999] 范围内的整数。

8.24.29.Milliseconds

功能

获取实例中保存的整数毫秒数。取值范围为 [0, 999] 的整数。
函数
```
int Milliseconds
```
参数：无。
返回值

[0, 999] 范围内的整数。

8.24.30.Seconds

功能

获取实例中保存的整数秒数。取值范围为 [0, 59] 的整数。
函数
```
int Seconds
```
参数：无。
返回值

[0, 59] 范围内的整数。

8.24.31.Minutes

功能

获取实例中保存的整数分钟数。取值范围为 [0, 59] 的整数。
函数
```
int Minutes
```
参数：无。
返回值

[0, 59] 范围内的整数。

8.24.32.Hours

功能

获取实例中保存的整数小时数。注意：为兼容往返转换，可存储 24:00:00 这一时间值；对该值做任何计算都会将其规范化为 00:00:00。
函数
```
int Hours
```
参数：无。
返回值

返回小时。

8.24.33.Normalize

功能

规范化该时间；若为 24:00:00，则转换为 00:00:00。
函数
```
NuxsqlTimeTZ Normalize()
```
参数：无。
返回值

规范化后的该时间值。

8.24.34.Equals

功能

判断是否与另一对象相等
函数
```
bool Equals(NuxsqlTimeTZ other)
```
参数

表 Equals 参数说明

名称描述

other（输入）另一个比较对象。
返回值

返回两个对象是否相等。

8.24.35.Equals

功能

判断是否与另一对象相等
函数
```
bool Equals(object obj)
```
参数

表 Equals 参数说明

名称描述

obj（输入）另一个对象。
返回值

返回两个对象是否相等。

8.24.36.GetHashCode

功能

获取对象的哈希码
函数
```
int GetHashCode()
```
参数：无。
返回值

返回对象的哈希码。

8.24.37.CompareTo

功能

将当前实例与另一个 NuxsqlTimeTZ 比较。按 UXDB 的规则，先将两个时间视为处于同一时区进行比较；若相等再比较时区（+01:00 比 -01:00 “更小”）。
函数
```
int CompareTo(NuxsqlTimeTZ other)
```
参数

表 CompareTo 参数说明

名称描述

other（输入）与之比较的 NuxsqlTimeTZ。
返回值

整数：两者相等时为 0，当前实例较小时小于 0，当前实例较大时大于 0。

8.24.38.CompareTo

功能

将当前实例与另一个 NuxsqlTimeTZ 比较。按 UXDB 的规则，先将两个时间视为处于同一时区进行比较；若相等再比较时区（+01:00 比 -01:00 “更小”）。
函数
```
int CompareTo(object obj)
```
参数

表 CompareTo 参数说明

名称描述

obj（输入）另一个对象。
返回值

整数：两者相等时为 0，当前实例较小时小于 0，当前实例较大时大于 0。

8.24.39.Compare

功能

比较

函数

int Compare(NuxsqlTimeTZ x, NuxsqlTimeTZ y)

参数

表 Compare 参数说明

名称描述

x（输入）第一个比较对象。

y（输入）第二个比较对象。
返回值

返回比较结果（小于、等于或大于）。

8.24.40.Compare

功能

比较
函数
```
int Compare(object x, object y)
```
参数

表 Compare 参数说明

名称描述

x（输入）第一个比较对象。

y（输入）第二个比较对象。
返回值

返回比较结果（小于、等于或大于）。

8.24.41.Add

功能

添加

函数

NuxsqlTimeTZ Add(NuxsqlInterval interval)

参数

表 Add 参数说明

名称描述

interval（输入）时间间隔对象。
返回值

返回添加后的结果。

8.24.42.Subtract

功能

减去

函数

NuxsqlTimeTZ Subtract(NuxsqlInterval interval)

参数

表 Subtract 参数说明

名称描述

interval（输入）时间间隔对象。
返回值

返回相减后的结果。

8.24.43.Subtract

功能

减去

函数

NuxsqlInterval Subtract(NuxsqlTimeTZ earlier)

参数

表 Subtract 参数说明

名称描述

earlier（输入）较早的时间对象。
返回值

返回相减后的结果。

8.24.44.NuxsqlTimeTZ

功能

构造函数

函数

explicit operator NuxsqlTimeTZ(TimeSpan time)

参数

表 NuxsqlTimeTZ 参数说明

名称描述

time（输入）时间对象。
返回值

返回一个 NuxsqlTimeTZ 对象。

8.24.45.TimeSpan

功能

时间跨度

函数

explicit operator TimeSpan(NuxsqlTimeTZ time)

参数

表 TimeSpan 参数说明

名称描述

time（输入）时间对象。
返回值

返回时间跨度。

8.24.46.DateTime

功能

日期时间

函数

explicit operator DateTime(NuxsqlTimeTZ time)

参数

表 DateTime 参数说明

名称描述

time（输入）时间对象。
返回值

返回日期时间。

8.25.NuxsqlTimeStamp（时间戳类型）

8.25.1.Epoch

功能

纪元

函数

NuxsqlTimeStamp Epoch = new NuxsqlTimeStamp(NuxsqlDate.Epoch)

参数：无。
返回值

返回纪元。

8.25.2.Era

功能

纪元

函数

NuxsqlTimeStamp Era = new NuxsqlTimeStamp(NuxsqlDate.Era)

参数：无。
返回值

返回纪元。

8.25.3.Infinity

功能

无穷

函数

NuxsqlTimeStamp Infinity = new NuxsqlTimeStamp(TimeType.Infinity, NuxsqlDate.Era, NuxsqlTime.AllBalls)

参数：无。
返回值

返回无穷。

8.25.4.MinusInfinity

功能

负无穷

函数

NuxsqlTimeStamp MinusInfinity = new NuxsqlTimeStamp(TimeType.MinusInfinity, NuxsqlDate.Era, NuxsqlTime.AllBalls)

参数：无。
返回值

返回负无穷。

8.25.5.Now

功能

当前时间
函数
```
NuxsqlTimeStamp Now
```
参数：无。
返回值

返回/设置当前时间。

8.25.6.Today

功能

转换为日
函数
```
NuxsqlTimeStamp Today
```
参数：无。
返回值

返回/设置转换为日。

8.25.7.Yesterday

功能

昨天
函数
```
NuxsqlTimeStamp Yesterday
```
参数：无。
返回值

返回/设置昨天。

8.25.8.Tomorrow

功能

明天
函数
```
NuxsqlTimeStamp Tomorrow
```
参数：无。
返回值

返回/设置明天。

8.25.9.NuxsqlTimeStamp

功能

构造函数

函数

NuxsqlTimeStamp(NuxsqlDate date, NuxsqlTime time)

参数

表 NuxsqlTimeStamp 参数说明

名称描述

date（输入）日期对象。

time（输入）时间对象。
返回值

返回一个 NuxsqlTimeStamp 对象。

8.25.10.NuxsqlTimeStamp

功能

构造函数
函数
```
NuxsqlTimeStamp(NuxsqlDate date)
```
参数

表 NuxsqlTimeStamp 参数说明

名称描述

date（输入）日期对象。
返回值

返回一个 NuxsqlTimeStamp 对象。

8.25.11.NuxsqlTimeStamp

功能

构造函数

函数

NuxsqlTimeStamp(int year, int month, int day, int hours, int minutes, int seconds) : this(new NuxsqlDate(year, month, day), new NuxsqlTime(hours, minutes, seconds))

参数

表 NuxsqlTimeStamp 参数说明

名称	描述
year（输入）	年。
month（输入）	月。
day（输入）	日。
hours（输入）	小时。
minutes（输入）	分钟。
seconds（输入）	秒。

返回值

返回一个 NuxsqlTimeStamp 对象。

8.25.12.Date

功能

获取日期
函数
```
NuxsqlDate Date
```
参数：无。
返回值

返回日期。

8.25.13.Time

功能

获取时间
函数
```
NuxsqlTime Time
```
参数：无。
返回值

返回时间。

8.25.14.DayOfYear

功能

获取一年中的第几天
函数
```
int DayOfYear
```
参数：无。
返回值

返回一年中的第几天。

8.25.15.Year

功能

获取年
函数
```
int Year
```
参数：无。
返回值

返回年。

8.25.16.Month

功能

获取月
函数
```
int Month
```
参数：无。
返回值

返回月。

8.25.17.Day

功能

获取日
函数
```
int Day
```
参数：无。
返回值

返回日。

8.25.18.DayOfWeek

功能

获取星期
函数
```
DayOfWeek DayOfWeek
```
参数：无。
返回值

返回星期。

8.25.19.IsLeapYear

功能

获取Is闰年
函数
```
bool IsLeapYear
```
参数：无。
返回值

返回Is闰年。

8.25.20.AddDays

功能

添加天
函数
```
NuxsqlTimeStamp AddDays(int days)
```
参数

表 AddDays 参数说明

名称描述

days（输入）天数。
返回值

返回添加指定天数后的结果。

8.25.21.AddYears

功能

添加年
函数
```
NuxsqlTimeStamp AddYears(int years)
```
参数

表 AddYears 参数说明

名称描述

years（输入）年数。
返回值

返回添加指定年数后的结果。

8.25.22.AddMonths

功能

添加月
函数
```
NuxsqlTimeStamp AddMonths(int months)
```
参数

表 AddMonths 参数说明

名称描述

months（输入）月数。
返回值

返回添加指定月数后的结果。

8.25.23.Ticks

功能

获取时钟周期
函数
```
long Ticks
```
参数：无。
返回值

返回时钟周期。

8.25.24.Microseconds

功能

获取微秒
函数
```
int Microseconds
```
参数：无。
返回值

返回微秒。

8.25.25.Milliseconds

功能

获取毫秒
函数
```
int Milliseconds
```
参数：无。
返回值

返回毫秒。

8.25.26.Seconds

功能

获取秒
函数
```
int Seconds
```
参数：无。
返回值

返回秒。

8.25.27.Minutes

功能

获取分钟
函数
```
int Minutes
```
参数：无。
返回值

返回分钟。

8.25.28.Hours

功能

获取小时
函数
```
int Hours
```
参数：无。
返回值

返回小时。

8.25.29.IsFinite

功能

获取Is有限
函数
```
bool IsFinite
```
参数：无。
返回值

返回Is有限。

8.25.30.IsInfinity

功能

获取Is无穷
函数
```
bool IsInfinity
```
参数：无。
返回值

返回Is无穷。

8.25.31.IsMinusInfinity

功能

获取Is负无穷
函数
```
bool IsMinusInfinity
```
参数：无。
返回值

返回Is负无穷。

8.25.32.Normalize

功能

规范化
函数
```
NuxsqlTimeStamp Normalize()
```
参数：无。
返回值

返回规范化后的结果。

8.25.33.ToString

功能

转换为字符串
函数
```
string ToString()
```
参数：无。
返回值

返回对象的字符串表示。

8.25.34.Parse

功能

解析
函数
```
NuxsqlTimeStamp Parse(string str)
```
参数

表 Parse 参数说明

名称描述

str（输入）要解析的字符串。
返回值

返回解析得到的对象。

8.25.35.Equals

功能

判断是否与另一对象相等
函数
```
bool Equals(NuxsqlTimeStamp other)
```
参数

表 Equals 参数说明

名称描述

other（输入）另一个比较对象。
返回值

返回两个对象是否相等。

8.25.36.Equals

功能

判断是否与另一对象相等
函数
```
bool Equals(object obj)
```
参数

表 Equals 参数说明

名称描述

obj（输入）另一个对象。
返回值

返回两个对象是否相等。

8.25.37.GetHashCode

功能

获取对象的哈希码
函数
```
int GetHashCode()
```
参数：无。
返回值

返回对象的哈希码。

8.25.38.CompareTo

功能

与另一对象比较大小
函数
```
int CompareTo(NuxsqlTimeStamp other)
```
参数

表 CompareTo 参数说明

名称描述

other（输入）另一个比较对象。
返回值

返回比较结果（小于、等于或大于）。

8.25.39.CompareTo

功能

与另一对象比较大小
函数
```
int CompareTo(object obj)
```
参数

表 CompareTo 参数说明

名称描述

obj（输入）另一个对象。
返回值

返回比较结果（小于、等于或大于）。

8.25.40.Compare

功能

比较

函数

int Compare(NuxsqlTimeStamp x, NuxsqlTimeStamp y)

参数

表 Compare 参数说明

名称描述

x（输入）第一个比较对象。

y（输入）第二个比较对象。
返回值

返回比较结果（小于、等于或大于）。

8.25.41.Compare

功能

比较
函数
```
int Compare(object x, object y)
```
参数

表 Compare 参数说明

名称描述

x（输入）第一个比较对象。

y（输入）第二个比较对象。
返回值

返回比较结果（小于、等于或大于）。

8.25.42.AtTimeZone

功能

转换到指定时区

函数

NuxsqlTimeStampTZ AtTimeZone(NuxsqlTimeZone timeZoneFrom, NuxsqlTimeZone timeZoneTo)

参数

表 AtTimeZone 参数说明

名称描述

timeZoneFrom（输入）起始时区。

timeZoneTo（输入）目标时区。
返回值

返回转换到指定时区后的结果。

8.25.43.AtTimeZone

功能

转换到指定时区

函数

NuxsqlTimeStampTZ AtTimeZone(NuxsqlTimeZone timeZone)

参数

表 AtTimeZone 参数说明

名称描述

timeZone（输入）时区对象。
返回值

返回转换到指定时区后的结果。

8.25.44.Add

功能

添加

函数

NuxsqlTimeStamp Add(NuxsqlInterval interval)

参数

表 Add 参数说明

名称描述

interval（输入）时间间隔对象。
返回值

返回添加后的结果。

8.25.45.Subtract

功能

减去

函数

NuxsqlTimeStamp Subtract(NuxsqlInterval interval)

参数

表 Subtract 参数说明

名称描述

interval（输入）时间间隔对象。
返回值

返回相减后的结果。

8.25.46.Subtract

功能

减去

函数

NuxsqlInterval Subtract(NuxsqlTimeStamp timestamp)

参数

表 Subtract 参数说明

名称描述

timestamp（输入）时间戳对象。
返回值

返回相减后的结果。

8.25.47.NuxsqlTimeStamp

功能

构造函数

函数

implicit operator NuxsqlTimeStamp(DateTime datetime)

参数

表 NuxsqlTimeStamp 参数说明

名称描述

datetime（输入）日期时间对象。
返回值

返回一个 NuxsqlTimeStamp 对象。

8.25.48.DateTime

功能

日期时间

函数

implicit operator DateTime(NuxsqlTimeStamp timestamp)

参数

表 DateTime 参数说明

名称描述

timestamp（输入）时间戳对象。
返回值

返回日期时间。

8.26.NuxsqlTimeStampTZ（带时区的时间戳类型）

8.26.1.Epoch

功能

纪元

函数

NuxsqlTimeStampTZ Epoch = new NuxsqlTimeStampTZ(NuxsqlDate.Epoch, NuxsqlTimeTZ.AllBalls)

参数：无。
返回值

返回纪元。

8.26.2.Era

功能

纪元

函数

NuxsqlTimeStampTZ Era = new NuxsqlTimeStampTZ(NuxsqlDate.Era, NuxsqlTimeTZ.AllBalls)

参数：无。
返回值

返回纪元。

8.26.3.Infinity

功能

无穷

函数

NuxsqlTimeStampTZ Infinity = new NuxsqlTimeStampTZ(TimeType.Infinity, NuxsqlDate.Era, NuxsqlTimeTZ.AllBalls)

参数：无。
返回值

返回无穷。

8.26.4.MinusInfinity

功能

负无穷

函数

NuxsqlTimeStampTZ MinusInfinity = new NuxsqlTimeStampTZ(TimeType.MinusInfinity, NuxsqlDate.Era, NuxsqlTimeTZ.AllBalls)

参数：无。
返回值

返回负无穷。

8.26.5.Now

功能

当前时间
函数
```
NuxsqlTimeStampTZ Now
```
参数：无。
返回值

返回/设置当前时间。

8.26.6.Today

功能

转换为日
函数
```
NuxsqlTimeStampTZ Today
```
参数：无。
返回值

返回/设置转换为日。

8.26.7.Yesterday

功能

昨天
函数
```
NuxsqlTimeStampTZ Yesterday
```
参数：无。
返回值

返回/设置昨天。

8.26.8.Tomorrow

功能

明天
函数
```
NuxsqlTimeStampTZ Tomorrow
```
参数：无。
返回值

返回/设置明天。

8.26.9.NuxsqlTimeStampTZ

功能

构造函数

函数

NuxsqlTimeStampTZ(NuxsqlDate date, NuxsqlTimeTZ time)

参数

表 NuxsqlTimeStampTZ 参数说明

名称描述

date（输入）日期对象。

time（输入）时间对象。
返回值

返回一个 NuxsqlTimeStampTZ 对象。

8.26.10.NuxsqlTimeStampTZ

功能

构造函数

函数

NuxsqlTimeStampTZ(NuxsqlDate date) : this(date, NuxsqlTimeTZ.LocalMidnight(date))

参数

表 NuxsqlTimeStampTZ 参数说明

名称描述

date（输入）日期对象。
返回值

返回一个 NuxsqlTimeStampTZ 对象。

8.26.11.NuxsqlTimeStampTZ

功能

构造函数

函数

NuxsqlTimeStampTZ(int year, int month, int day, int hours, int minutes, int seconds, NuxsqlTimeZone? timezone) : this( new NuxsqlDate(year, month, day), new NuxsqlTimeTZ(hours, minutes, seconds, timezone.HasValue ? timezone.Value : NuxsqlTimeZone.LocalTimeZone(new NuxsqlDate(year, month, day))) )

参数

表 NuxsqlTimeStampTZ 参数说明

名称	描述
year（输入）	年。
month（输入）	月。
day（输入）	日。
hours（输入）	小时。
minutes（输入）	分钟。
seconds（输入）	秒。
timezone（输入）	时区对象。

返回值

返回一个 NuxsqlTimeStampTZ 对象。

8.26.12.Date

功能

获取日期
函数
```
NuxsqlDate Date
```
参数：无。
返回值

返回日期。

8.26.13.Time

功能

获取时间
函数
```
NuxsqlTimeTZ Time
```
参数：无。
返回值

返回时间。

8.26.14.DayOfYear

功能

获取一年中的第几天
函数
```
int DayOfYear
```
参数：无。
返回值

返回一年中的第几天。

8.26.15.Year

功能

获取年
函数
```
int Year
```
参数：无。
返回值

返回年。

8.26.16.Month

功能

获取月
函数
```
int Month
```
参数：无。
返回值

返回月。

8.26.17.Day

功能

获取日
函数
```
int Day
```
参数：无。
返回值

返回日。

8.26.18.DayOfWeek

功能

获取星期
函数
```
DayOfWeek DayOfWeek
```
参数：无。
返回值

返回星期。

8.26.19.IsLeapYear

功能

获取Is闰年
函数
```
bool IsLeapYear
```
参数：无。
返回值

返回Is闰年。

8.26.20.AddDays

功能

添加天
函数
```
NuxsqlTimeStampTZ AddDays(int days)
```
参数

表 AddDays 参数说明

名称描述

days（输入）天数。
返回值

返回添加指定天数后的结果。

8.26.21.AddYears

功能

添加年
函数
```
NuxsqlTimeStampTZ AddYears(int years)
```
参数

表 AddYears 参数说明

名称描述

years（输入）年数。
返回值

返回添加指定年数后的结果。

8.26.22.AddMonths

功能

添加月

函数

NuxsqlTimeStampTZ AddMonths(int months)

参数

表 AddMonths 参数说明

名称描述

months（输入）月数。
返回值

返回添加指定月数后的结果。

8.26.23.LocalTime

功能

获取本地时间
函数
```
NuxsqlTime LocalTime
```
参数：无。
返回值

返回本地时间。

8.26.24.TimeZone

功能

获取时区
函数
```
NuxsqlTimeZone TimeZone
```
参数：无。
返回值

返回时区。

8.26.25.UTCTime

功能

获取UTC时间
函数
```
NuxsqlTime UTCTime
```
参数：无。
返回值

返回UTC时间。

8.26.26.Ticks

功能

获取时钟周期
函数
```
long Ticks
```
参数：无。
返回值

返回时钟周期。

8.26.27.Microseconds

功能

获取微秒
函数
```
int Microseconds
```
参数：无。
返回值

返回微秒。

8.26.28.Milliseconds

功能

获取毫秒
函数
```
int Milliseconds
```
参数：无。
返回值

返回毫秒。

8.26.29.Seconds

功能

获取秒
函数
```
int Seconds
```
参数：无。
返回值

返回秒。

8.26.30.Minutes

功能

获取分钟
函数
```
int Minutes
```
参数：无。
返回值

返回分钟。

8.26.31.Hours

功能

获取小时
函数
```
int Hours
```
参数：无。
返回值

返回小时。

8.26.32.IsFinite

功能

获取Is有限
函数
```
bool IsFinite
```
参数：无。
返回值

返回Is有限。

8.26.33.IsInfinity

功能

获取Is无穷
函数
```
bool IsInfinity
```
参数：无。
返回值

返回Is无穷。

8.26.34.IsMinusInfinity

功能

获取Is负无穷
函数
```
bool IsMinusInfinity
```
参数：无。
返回值

返回Is负无穷。

8.26.35.Normalize

功能

规范化
函数
```
NuxsqlTimeStampTZ Normalize()
```
参数：无。
返回值

返回规范化后的结果。

8.26.36.ToString

功能

转换为字符串
函数
```
string ToString()
```
参数：无。
返回值

返回对象的字符串表示。

8.26.37.Parse

功能

解析
函数
```
NuxsqlTimeStampTZ Parse(string str)
```
参数

表 Parse 参数说明

名称描述

str（输入）要解析的字符串。
返回值

返回解析得到的对象。

8.26.38.Equals

功能

判断是否与另一对象相等
函数
```
bool Equals(NuxsqlTimeStampTZ other)
```
参数

表 Equals 参数说明

名称描述

other（输入）另一个比较对象。
返回值

返回两个对象是否相等。

8.26.39.Equals

功能

判断是否与另一对象相等
函数
```
bool Equals(object obj)
```
参数

表 Equals 参数说明

名称描述

obj（输入）另一个对象。
返回值

返回两个对象是否相等。

8.26.40.GetHashCode

功能

获取对象的哈希码
函数
```
int GetHashCode()
```
参数：无。
返回值

返回对象的哈希码。

8.26.41.CompareTo

功能

与另一对象比较大小
函数
```
int CompareTo(NuxsqlTimeStampTZ other)
```
参数

表 CompareTo 参数说明

名称描述

other（输入）另一个比较对象。
返回值

返回比较结果（小于、等于或大于）。

8.26.42.CompareTo

功能

与另一对象比较大小
函数
```
int CompareTo(object obj)
```
参数

表 CompareTo 参数说明

名称描述

obj（输入）另一个对象。
返回值

返回比较结果（小于、等于或大于）。

8.26.43.Compare

功能

比较

函数

int Compare(NuxsqlTimeStampTZ x, NuxsqlTimeStampTZ y)

参数

表 Compare 参数说明

名称描述

x（输入）第一个比较对象。

y（输入）第二个比较对象。
返回值

返回比较结果（小于、等于或大于）。

8.26.44.Compare

功能

比较
函数
```
int Compare(object x, object y)
```
参数

表 Compare 参数说明

名称描述

x（输入）第一个比较对象。

y（输入）第二个比较对象。
返回值

返回比较结果（小于、等于或大于）。

8.26.45.AtTimeZone

功能

转换到指定时区

函数

NuxsqlTimeStamp AtTimeZone(NuxsqlTimeZone timeZone)

参数

表 AtTimeZone 参数说明

名称描述

timeZone（输入）时区对象。
返回值

返回转换到指定时区后的结果。

8.26.46.Add

功能

添加

函数

NuxsqlTimeStampTZ Add(NuxsqlInterval interval)

参数

表 Add 参数说明

名称描述

interval（输入）时间间隔对象。
返回值

返回添加后的结果。

8.26.47.Subtract

功能

减去

函数

NuxsqlTimeStampTZ Subtract(NuxsqlInterval interval)

参数

表 Subtract 参数说明

名称描述

interval（输入）时间间隔对象。
返回值

返回相减后的结果。

8.26.48.Subtract

功能

减去

函数

NuxsqlInterval Subtract(NuxsqlTimeStampTZ timestamp)

参数

表 Subtract 参数说明

名称描述

timestamp（输入）时间戳对象。
返回值

返回相减后的结果。

8.26.49.NuxsqlTimeStampTZ

功能

构造函数

函数

implicit operator NuxsqlTimeStampTZ(DateTime datetime)

参数

表 NuxsqlTimeStampTZ 参数说明

名称描述

datetime（输入）日期时间对象。
返回值

返回一个 NuxsqlTimeStampTZ 对象。

8.26.50.DateTime

功能

日期时间

函数

explicit operator DateTime(NuxsqlTimeStampTZ timestamp)

参数

表 DateTime 参数说明

名称描述

timestamp（输入）时间戳对象。
返回值

返回日期时间。

8.26.51.NuxsqlTimeStampTZ

功能

构造函数

函数

implicit operator NuxsqlTimeStampTZ(DateTimeOffset datetimeoffset)

参数

表 NuxsqlTimeStampTZ 参数说明

名称描述

datetimeoffset（输入） DateTimeOffset 对象。
返回值

返回一个 NuxsqlTimeStampTZ 对象。

8.26.52.DateTimeOffset

功能

日期时间偏移

函数

explicit operator DateTimeOffset(NuxsqlTimeStampTZ timestamp)

参数

表 DateTimeOffset 参数说明

名称描述

timestamp（输入）时间戳对象。
返回值

返回日期时间偏移。

8.27.NuxsqlTimeZone（时区偏移类型）

8.27.1.UTC

功能

UTC 时区（偏移量为 0）

函数

NuxsqlTimeZone UTC = new NuxsqlTimeZone(0)

参数：无。
返回值

返回UTC 时区（偏移量为 0）。

8.27.2.NuxsqlTimeZone

功能

构造函数
函数
```
NuxsqlTimeZone(TimeSpan ts)
```
参数

表 NuxsqlTimeZone 参数说明

名称描述

ts（输入）时间跨度。
返回值

返回一个 NuxsqlTimeZone 对象。

8.27.3.NuxsqlTimeZone

功能

构造函数
函数
```
NuxsqlTimeZone(NuxsqlInterval ni)
```
参数

表 NuxsqlTimeZone 参数说明

名称描述

ni（输入）时间间隔对象。
返回值

返回一个 NuxsqlTimeZone 对象。

8.27.4.NuxsqlTimeZone

功能

构造函数

函数

NuxsqlTimeZone(NuxsqlTimeZone copyFrom)

参数

表 NuxsqlTimeZone 参数说明

名称描述

copyFrom（输入）要复制的对象。
返回值

返回一个 NuxsqlTimeZone 对象。

8.27.5.NuxsqlTimeZone

功能

构造函数
函数
```
NuxsqlTimeZone(int hours, int minutes)
```
参数

表 NuxsqlTimeZone 参数说明

名称描述

hours（输入）小时。

minutes（输入）分钟。
返回值

返回一个 NuxsqlTimeZone 对象。

8.27.6.NuxsqlTimeZone

功能

构造函数

函数

NuxsqlTimeZone(int hours, int minutes, int seconds)

参数

表 NuxsqlTimeZone 参数说明

名称描述

hours（输入）小时。

minutes（输入）分钟。

seconds（输入）秒。
返回值

返回一个 NuxsqlTimeZone 对象。

8.27.7.NuxsqlTimeZone

功能

构造函数

函数

implicit operator NuxsqlTimeZone(NuxsqlInterval interval)

参数

表 NuxsqlTimeZone 参数说明

名称描述

interval（输入）时间间隔对象。
返回值

返回一个 NuxsqlTimeZone 对象。

8.27.8.NuxsqlInterval

功能

UXDB时间间隔

函数

implicit operator NuxsqlInterval(NuxsqlTimeZone timeZone)

参数

表 NuxsqlInterval 参数说明

名称描述

timeZone（输入）时区对象。
返回值

返回UXDB时间间隔。

8.27.9.NuxsqlTimeZone

功能

构造函数

函数

implicit operator NuxsqlTimeZone(TimeSpan interval)

参数

表 NuxsqlTimeZone 参数说明

名称描述

interval（输入）时间间隔对象。
返回值

返回一个 NuxsqlTimeZone 对象。

8.27.10.TimeSpan

功能

时间跨度

函数

implicit operator TimeSpan(NuxsqlTimeZone timeZone)

参数

表 TimeSpan 参数说明

名称描述

timeZone（输入）时区对象。
返回值

返回时间跨度。

8.27.11.SolarTimeZone

功能

太阳时间时区

函数

NuxsqlTimeZone SolarTimeZone(decimal longitude)

参数

表 SolarTimeZone 参数说明

名称描述

longitude（输入）经度（度）。
返回值

返回计算得到的太阳时区。

8.27.12.Hours

功能

获取小时
函数
```
int Hours
```
参数：无。
返回值

返回小时。

8.27.13.Minutes

功能

分钟
函数
```
int Minutes
```
参数：无。
返回值

返回/设置分钟。

8.27.14.Seconds

功能

获取秒
函数
```
int Seconds
```
参数：无。
返回值

返回秒。

8.27.15.CurrentTimeZone

功能

当前时间时区
函数
```
NuxsqlTimeZone CurrentTimeZone
```
参数：无。
返回值

返回/设置当前时间时区。

8.27.16.LocalTimeZone

功能

本地时间时区

函数

NuxsqlTimeZone LocalTimeZone(NuxsqlDate date)

参数

表 LocalTimeZone 参数说明

名称描述

date（输入）日期对象。
返回值

返回本地时区。

8.27.17.Equals

功能

判断是否与另一对象相等
函数
```
bool Equals(NuxsqlTimeZone other)
```
参数

表 Equals 参数说明

名称描述

other（输入）另一个比较对象。
返回值

返回两个对象是否相等。

8.27.18.Equals

功能

判断是否与另一对象相等
函数
```
bool Equals(object obj)
```
参数

表 Equals 参数说明

名称描述

obj（输入）另一个对象。
返回值

返回两个对象是否相等。

8.27.19.ToString

功能

转换为字符串
函数
```
string ToString()
```
参数：无。
返回值

返回对象的字符串表示。

8.27.20.Parse

功能

解析
函数
```
NuxsqlTimeZone Parse(string str)
```
参数

表 Parse 参数说明

名称描述

str（输入）要解析的字符串。
返回值

返回解析得到的对象。

8.27.21.TryParse

功能

尝试解析

函数

bool TryParse(string str, NuxsqlTimeZone tz)

参数

表 TryParse 参数说明

名称描述

str（输入）要解析的字符串。

tz（输入）时区对象。
返回值

返回是否解析成功。

8.27.22.GetHashCode

功能

获取对象的哈希码
函数
```
int GetHashCode()
```
参数：无。
返回值

返回对象的哈希码。

8.27.23.CompareTo

功能

与另一对象比较大小
函数
```
int CompareTo(NuxsqlTimeZone other)
```
参数

表 CompareTo 参数说明

名称描述

other（输入）另一个比较对象。
返回值

返回比较结果（小于、等于或大于）。

8.27.24.CompareTo

功能

与另一对象比较大小
函数
```
int CompareTo(object obj)
```
参数

表 CompareTo 参数说明

名称描述

obj（输入）另一个对象。
返回值

返回比较结果（小于、等于或大于）。

8.28.NuxsqlInterval（时间间隔类型）

8.28.1.TicksPerMicrosecond

功能

表示一微秒中的计时周期数（100 纳秒周期）。该字段为常量。

函数

long TicksPerMicrosecond = TimeSpan.TicksPerMillisecond/1000

参数：无。
返回值

返回每微秒的时钟周期数。

8.28.2.TicksPerMillsecond

功能

表示一毫秒中的计时周期数（100 纳秒周期）。该字段为常量。

函数

long TicksPerMillsecond = TimeSpan.TicksPerMillisecond

参数：无。
返回值

返回每毫秒的时钟周期数。

8.28.3.TicksPerSecond

功能

表示一秒中的计时周期数（100 纳秒周期）。该字段为常量。

函数

long TicksPerSecond = TimeSpan.TicksPerSecond

参数：无。
返回值

返回每秒的时钟周期数。

8.28.4.TicksPerMinute

功能

表示一分钟中的计时周期数（100 纳秒周期）。该字段为常量。

函数

long TicksPerMinute = TimeSpan.TicksPerMinute

参数：无。
返回值

返回每分钟的时钟周期数。

8.28.5.TicksPerHour

功能

表示一小时中的计时周期数（100 纳秒周期）。该字段为常量。

函数

long TicksPerHour = TimeSpan.TicksPerHour

参数：无。
返回值

返回每小时的时钟周期数。

8.28.6.TicksPerDay

功能

表示一天中的计时周期数（100 纳秒周期）。该字段为常量。

函数

long TicksPerDay = TimeSpan.TicksPerDay

参数：无。
返回值

返回每日的时钟周期数。

8.28.7.HoursPerDay

功能

表示一天中的小时数（假定不做夏令时调整）。该字段为常量。
函数
```
int HoursPerDay = 24
```
参数：无。
返回值

返回每日的小时数。

8.28.8.DaysPerMonth

功能

表示执行月份规范化或反规范化时一个月所假定采用的天数。为与 UXDB 保持一致，该值设为 30。注意这意味着按月份调整时，一年按 30 × 12 = 360 天计算，而非 365/366 天。
函数
```
int DaysPerMonth = 30
```
参数：无。
返回值

返回每月的天数。

8.28.9.TicksPerMonth

功能

表示一天中的计时周期数（100 纳秒周期），假定每月 30 天。

函数

long TicksPerMonth = TicksPerDay*DaysPerMonth

参数：无。
返回值

返回每月的时钟周期数。

8.28.10.MonthsPerYear

功能

表示一年中的月数。该字段为常量。
函数
```
int MonthsPerYear = 12
```
参数：无。
返回值

返回每年的月数。

8.28.11.MaxValue

功能

最大值

函数

NuxsqlInterval MaxValue = new NuxsqlInterval(long.MaxValue)

参数：无。
返回值

返回最大值。

8.28.12.MinValue

功能

最小值

函数

NuxsqlInterval MinValue = new NuxsqlInterval(long.MinValue)

参数：无。
返回值

返回最小值。

8.28.13.Zero

功能

零

函数

NuxsqlInterval Zero = new NuxsqlInterval(0)

参数：无。
返回值

返回零。

8.28.14.NuxsqlInterval

功能

按指定的计时周期数初始化一个新的 NuxsqlInterval。

函数

NuxsqlInterval(long ticks) : this(new TimeSpan(ticks))

参数

表 NuxsqlInterval 参数说明

名称描述

ticks（输入）以 100 纳秒为单位表示的时间段。
返回值

返回一个 NuxsqlInterval 对象。

8.28.15.NuxsqlInterval

功能

按指定的月数、天数和计时周期数初始化一个新的 NuxsqlInterval。

函数

NuxsqlInterval(TimeSpan timespan) : this(0, timespan.Days, timespan.Ticks - (TicksPerDay * timespan.Days))

参数

表 NuxsqlInterval 参数说明

名称描述

timespan（输入）时间跨度。
返回值

返回一个 NuxsqlInterval 对象。

8.28.16.NuxsqlInterval

功能

按指定的月数、天数和计时周期数初始化一个新的 NuxsqlInterval。

函数

NuxsqlInterval(int months, int days, long ticks)

参数

表 NuxsqlInterval 参数说明

名称描述

months（输入）月数。

days（输入）天数。

ticks（输入）以 100 纳秒为单位的数量。
返回值

返回一个 NuxsqlInterval 对象。

8.28.17.NuxsqlInterval

功能

按指定的月数、天数、小时数、分钟数、秒数和毫秒数初始化一个新的 NuxsqlInterval。

函数

NuxsqlInterval(int days, int hours, int minutes, int seconds) : this(0, days, new TimeSpan(hours, minutes, seconds).Ticks)

参数

表 NuxsqlInterval 参数说明

名称	描述
days（输入）	天数。
hours（输入）	小时数。
minutes（输入）	分钟数。
seconds（输入）	秒数。

返回值

返回一个 NuxsqlInterval 对象。

8.28.18.NuxsqlInterval

功能

按指定的年数、月数、天数、小时数、分钟数、秒数和毫秒数初始化一个新的 NuxsqlInterval。年按精确等于 12 个月计算。

函数

NuxsqlInterval(int days, int hours, int minutes, int seconds, int milliseconds) : this(0, days, new TimeSpan(0, hours, minutes, seconds, milliseconds).Ticks)

参数

表 NuxsqlInterval 参数说明

名称	描述
days（输入）	天数。
hours（输入）	小时数。
minutes（输入）	分钟数。
seconds（输入）	秒数。
milliseconds（输入）	毫秒数。

返回值

返回一个 NuxsqlInterval 对象。

8.28.19.NuxsqlInterval

功能

构造函数

函数

NuxsqlInterval(int months, int days, int hours, int minutes, int seconds, int milliseconds) : this(months, days, new TimeSpan(0, hours, minutes, seconds, milliseconds).Ticks)

参数

表 NuxsqlInterval 参数说明

名称	描述
months（输入）	月数。
days（输入）	天数。
hours（输入）	小时。
minutes（输入）	分钟。
seconds（输入）	秒。
milliseconds（输入）	毫秒。

返回值

返回一个 NuxsqlInterval 对象。

8.28.20.NuxsqlInterval

功能

构造函数

函数

NuxsqlInterval(int years, int months, int days, int hours, int minutes, int seconds, int milliseconds) : this(years*12 + months, days, new TimeSpan(0, hours, minutes, seconds, milliseconds).Ticks)

参数

表 NuxsqlInterval 参数说明

名称	描述
years（输入）	年数。
months（输入）	月数。
days（输入）	天数。
hours（输入）	小时。
minutes（输入）	分钟。
seconds（输入）	秒。
milliseconds（输入）	毫秒。

返回值

返回一个 NuxsqlInterval 对象。

8.28.21.Ticks

功能

实例中包含的计时周期总数（100 纳秒单位）。这是 NuxsqlInterval 类型的分辨率。该值忽略所保存的天数和月数；若要将其计入，请先使用 UnjustifyInterval。UXDB interval 类型的默认分辨率为 1µs = 1,000 ns，也可能更小，具体如下：interval(0) 分辨率为 1s（1 秒）；interval(1) 分辨率为 100ms = 0.1s（100 毫秒）；interval(2) 分辨率为 10ms = 0.01s（10 毫秒）；interval(3) 分辨率为 1ms = 0.001s（1 毫秒）；interval(4) 分辨率为 100µs = 0.0001s（100 微秒）；interval(5) 分辨率为 10µs = 0.00001s（10 微秒）；interval(6) 或 interval 分辨率为 1µs = 0.000001s（1 微秒）。因此，若应用程序看重 100 纳秒的分辨率，UXDB 的 interval 将无法满足需求。不过在多数情况下，interval 的分辨率已足够。NuxsqlInterval 始终足以处理任意 interval 值的分辨率，写入数据库时会按所用分辨率进行舍入。即实例中的计时周期数。
函数
```
long Ticks
```
参数：无。
返回值

实例中的计时周期数。

8.28.22.Microseconds

功能

获取实例中保存的整数微秒数。取值范围为 [-999999, 999999]。
函数
```
int Microseconds
```
参数：无。
返回值

[-999999, 999999] 范围内的值。

8.28.23.Milliseconds

功能

获取实例中保存的整数毫秒数。取值范围为 [-999, 999]。
函数
```
int Milliseconds
```
参数：无。
返回值

[-999, 999] 范围内的值。

8.28.24.Seconds

功能

获取实例中保存的整数秒数。取值范围为 [-59, 59]。
函数
```
int Seconds
```
参数：无。
返回值

[-59, 59] 范围内的值。

8.28.25.Minutes

功能

获取实例中保存的整数分钟数。取值范围为 [-59, 59]。
函数
```
int Minutes
```
参数：无。
返回值

[-59, 59] 范围内的值。

8.28.26.Hours

功能

获取实例中保存的整数小时数。注意：除非已使用 JustifyDays 生成该实例，否则该值可能小于 -23 或大于 23。
函数
```
int Hours
```
参数：无。
返回值

返回/设置小时。

8.28.27.Days

功能

获取实例中保存的天数。注意：除非已调用 JustifyDays 生成该实例，否则不会考虑时间分量中小于等于 -24 小时或大于等于 24 小时的部分。
函数
```
int Days
```
参数：无。
返回值

返回天。

8.28.28.Months

功能

获取实例中保存的月数。注意：除非已调用 JustifyMonths 生成该实例，否则不会考虑日期分量中小于等于 -30 天或大于等于 30 天的部分。
函数
```
int Months
```
参数：无。
返回值

返回月。

8.28.29.Time

功能

返回表示实例时间分量的 TimeSpan。注意：除非已调用 JustifyDays 生成该实例，否则其值可能超出 ±23:59:59.9999999 的范围。
函数
```
TimeSpan Time
```
参数：无。
返回值

返回/设置时间。

8.28.30.TotalTicks

功能

实例中的计时周期总数（100 纳秒单位），假定每天 24 小时、每月 30 天。
函数
```
long TotalTicks
```
参数：无。
返回值

返回总时钟周期。

8.28.31.TotalMicroseconds

功能

实例中的总微秒数，假定每天 24 小时、每月 30 天。
函数
```
double TotalMicroseconds
```
参数：无。
返回值

返回总微秒。

8.28.32.TotalMilliseconds

功能

实例中的总毫秒数，假定每天 24 小时、每月 30 天。
函数
```
double TotalMilliseconds
```
参数：无。
返回值

返回总毫秒。

8.28.33.TotalSeconds

功能

实例中的总秒数，假定每天 24 小时、每月 30 天。
函数
```
double TotalSeconds
```
参数：无。
返回值

返回总秒。

8.28.34.TotalMinutes

功能

实例中的总分钟数，假定每天 24 小时、每月 30 天。
函数
```
double TotalMinutes
```
参数：无。
返回值

返回总分钟。

8.28.35.TotalHours

功能

实例中的总小时数，假定每天 24 小时、每月 30 天。
函数
```
double TotalHours
```
参数：无。
返回值

返回总小时。

8.28.36.TotalDays

功能

实例中的总天数，假定每天 24 小时、每月 30 天。
函数
```
double TotalDays
```
参数：无。
返回值

返回总天。

8.28.37.TotalMonths

功能

实例中的总月数，假定每天 24 小时、每月 30 天。
函数
```
double TotalMonths
```
参数：无。
返回值

返回总月。

8.28.38.FromTicks

功能

由指定计时周期数创建 NuxsqlInterval。
函数
```
NuxsqlInterval FromTicks(long ticks)
```
参数

表 FromTicks 参数说明

名称描述

ticks（输入）时间间隔中的计时周期数（100 纳秒单位）。
返回值

具有指定计时周期数的规范化 NuxsqlInterval。

8.28.39.FromMicroseconds

功能

由指定微秒数创建 NuxsqlInterval。

函数

NuxsqlInterval FromMicroseconds(double micro)

参数

表 FromMicroseconds 参数说明

名称描述

micro（输入）时间间隔中的微秒数。
返回值

具有指定微秒数的规范化 NuxsqlInterval。

8.28.40.FromMilliseconds

功能

由指定毫秒数创建 NuxsqlInterval。

函数

NuxsqlInterval FromMilliseconds(double milli)

参数

表 FromMilliseconds 参数说明

名称描述

milli（输入）时间间隔中的毫秒数。
返回值

具有指定毫秒数的规范化 NuxsqlInterval。

8.28.41.FromSeconds

功能

由指定秒数创建 NuxsqlInterval。

函数

NuxsqlInterval FromSeconds(double seconds)

参数

表 FromSeconds 参数说明

名称描述

seconds（输入）时间间隔中的秒数。
返回值

具有指定秒数的规范化 NuxsqlInterval。

8.28.42.FromMinutes

功能

由指定分钟数创建 NuxsqlInterval。

函数

NuxsqlInterval FromMinutes(double minutes)

参数

表 FromMinutes 参数说明

名称描述

minutes（输入）时间间隔中的分钟数。
返回值

具有指定分钟数的规范化 NuxsqlInterval。

8.28.43.FromHours

功能

由指定小时数创建 NuxsqlInterval。
函数
```
NuxsqlInterval FromHours(double hours)
```
参数

表 FromHours 参数说明

名称描述

hours（输入）时间间隔中的小时数。
返回值

具有指定小时数的规范化 NuxsqlInterval。

8.28.44.FromDays

功能

由指定天数创建 NuxsqlInterval。
函数
```
NuxsqlInterval FromDays(double days)
```
参数

表 FromDays 参数说明

名称描述

days（输入）时间间隔中的天数。
返回值

具有指定天数的规范化 NuxsqlInterval。

8.28.45.FromMonths

功能

由指定月数创建 NuxsqlInterval。

函数

NuxsqlInterval FromMonths(double months)

参数

表 FromMonths 参数说明

名称描述

months（输入）时间间隔中的月数。
返回值

具有指定月数的规范化 NuxsqlInterval。

8.28.46.Add

功能

将另一个时间间隔加到当前实例上并返回结果。

函数

NuxsqlInterval Add(NuxsqlInterval interval)

参数

表 Add 参数说明

名称描述

interval（输入）要加到当前实例上的 NuxsqlInterval。
返回值

值为两个实例之和的 NuxsqlInterval。

8.28.47.Subtract

功能

从当前实例中减去另一个时间间隔并返回结果。

函数

NuxsqlInterval Subtract(NuxsqlInterval interval)

参数

表 Subtract 参数说明

名称描述

interval（输入）要从当前实例中减去的 NuxsqlInterval。
返回值

值为两个实例之差的 NuxsqlInterval。

8.28.48.Negate

功能

返回值为当前实例取负结果的 NuxsqlInterval。
函数
```
NuxsqlInterval Negate()
```
参数：无。
返回值

值为当前实例取负结果的 NuxsqlInterval。

8.28.49.Duration

功能

当前实例的绝对值。在部分（而非全部）分量为负的情况下，将采用规范化所用的规则来判断该实例为正还是为负。
函数
```
NuxsqlInterval Duration()
```
参数：无。
返回值

值为当前实例绝对值的 NuxsqlInterval。

8.28.50.JustifyDays

功能

等效于 UXDB 的 justify_days 函数。
函数
```
NuxsqlInterval JustifyDays()
```
参数：无。
返回值

基于当前实例的 NuxsqlInterval，但超出 [-23, 23] 范围的小时数已换算为天。

8.28.51.UnjustifyDays

功能

与 UXDB 的 justify_days 函数相反。
函数
```
NuxsqlInterval UnjustifyDays()
```
参数：无。
返回值

基于当前实例的 NuxsqlInterval，但其中的天数已换算为 ±24 小时的整数倍。

8.28.52.JustifyMonths

功能

等效于 UXDB 的 justify_months 函数。
函数
```
NuxsqlInterval JustifyMonths()
```
参数：无。
返回值

基于当前实例的 NuxsqlInterval，但超出 [-30, 30] 范围的天数已换算为月。

8.28.53.UnjustifyMonths

功能

与 UXDB 的 justify_months 函数相反。
函数
```
NuxsqlInterval UnjustifyMonths()
```
参数：无。
返回值

基于当前实例的 NuxsqlInterval，但其中的月数已换算为 ±30 天的整数倍。

8.28.54.JustifyInterval

功能

等效于 UXDB 的 justify_interval 函数。
函数
```
NuxsqlInterval JustifyInterval()
```
参数：无。
返回值

基于当前实例的 NuxsqlInterval，但其中的月数已换算为 ±30 天的整数倍，天数随后再换算为 ±24 小时的整数倍。

8.28.55.UnjustifyInterval

功能

与 UXDB 的 justify_interval 函数相反。
函数
```
NuxsqlInterval UnjustifyInterval()
```
参数：无。
返回值

基于当前实例的 NuxsqlInterval，但其中的月数已换算为 ±30 天的整数倍，天数再换算为 ±24 小时的整数倍。

8.28.56.Canonicalize

功能

生成一个月数为 0 且小时数在 [-23, 23] 范围内的规范化 NuxsqlInterval。虽然在多数场景下两个不同的 NuxsqlInterval 实例可能被视为等价（例如一个为 2 天 3 小时，另一个为 1 天 27 小时），但存在多种可能的规范形式：例如可以把超出的小时并入天、把超出的天并入月以得到最易读的形式，也可以全部并入计时周期以得到最便于运算的形式。此处选用的形式有两个使其成为最佳选择的重要特性：第一，它最接近 TimeSpan 对象最常见的表示方式；第二，它与许多 UXDB 函数的结果兼容，特别是 age() 以及两个 date、time 或 timestamp 相减的结果。注意，将 TimeSpan 强制转换为 NuxsqlInterval 的结果也会被规范化。
函数
```
NuxsqlInterval Canonicalize()
```
参数：无。
返回值

基于当前实例的 NuxsqlInterval，但其中的月数已换算为 ±30 天的整数倍，且超出 [-23, 23] 范围的小时数已换算为天。

8.28.57.NuxsqlInterval

功能

初始化一个新的 NuxsqlInterval，使其保存与 TimeSpan 相同的时间。

函数

implicit operator NuxsqlInterval(TimeSpan timespan)

参数

表 NuxsqlInterval 参数说明

名称描述

timespan（输入）以 TimeSpan 表示的时间段。
返回值

返回一个 NuxsqlInterval 对象。

8.28.58.TimeSpan

功能

时间跨度

函数

explicit operator TimeSpan(NuxsqlInterval interval)

参数

表 TimeSpan 参数说明

名称描述

interval（输入）时间间隔对象。
返回值

返回时间跨度。

8.28.59.Equals

功能

若另一个 NuxsqlInterval 与当前实例完全相同，则返回 true。
函数
```
bool Equals(NuxsqlInterval other)
```
参数

表 Equals 参数说明

名称描述

other（输入）用于比较的 NuxsqlInterval。
返回值

若两个 NuxsqlInterval 实例完全相同则为 true，否则为 false。

8.28.60.Equals

功能

若另一个 NuxsqlInterval 与当前实例完全相同，则返回 true。
函数
```
bool Equals(object obj)
```
参数

表 Equals 参数说明

名称描述

obj（输入）另一个对象。
返回值

若两个 NuxsqlInterval 实例完全相同则为 true，否则为 false。

8.28.61.Compare

功能

比较两个 NuxsqlInterval 实例。

函数

int Compare(NuxsqlInterval x, NuxsqlInterval y)

参数

表 Compare 参数说明

名称描述

x（输入）第一个 NuxsqlInterval。

y（输入）第二个 NuxsqlInterval。
返回值

若两者相等或等效则返回 0；若 x 大于 y 则返回大于 0 的值；若 x 小于 y 则返回小于 0 的值。

8.28.62.GetHashCode

功能

适用于哈希算法的哈希码。
函数
```
int GetHashCode()
```
参数：无。
返回值

有符号整数。

8.28.63.CompareTo

功能

将当前实例与另一个实例进行比较。
函数
```
int CompareTo(NuxsqlInterval other)
```
参数

表 CompareTo 参数说明

名称描述

other（输入）与当前实例进行比较的 NuxsqlInterval。
返回值

若两个实例相等或等效则返回 0；若当前实例小于参数则返回小于 0 的值；若当前实例大于参数则返回大于 0 的值。

8.28.64.CompareTo

功能

将当前实例与另一个实例进行比较。
函数
```
int CompareTo(object other)
```
参数

表 CompareTo 参数说明

名称描述

other（输入）与当前实例进行比较的 NuxsqlInterval。
返回值

若两个实例相等或等效则返回 0；若当前实例小于参数则返回小于 0 的值；若当前实例大于参数则返回大于 0 的值。

8.28.65.Parse

功能

解析字符串并返回 NuxsqlInterval 实例。设计用于解析 UXDB 通常返回的格式。
函数
```
NuxsqlInterval Parse(string str)
```
参数

表 Parse 参数说明

名称描述

str（输入）要解析的字符串。
返回值

由参数所表示的 NuxsqlInterval。

8.28.66.TryParse

功能

尝试解析字符串以生成 NuxsqlInterval。

函数

bool TryParse(string str, out NuxsqlInterval result)

参数

表 TryParse 参数说明

名称	描述
str（输入）	要解析的字符串。
result（输出）	（输出）解析得到的 NuxsqlInterval；若解析失败则为 Zero。

返回值

若解析成功则为 true，否则为 false。

8.28.67.ToString

功能

创建 NuxsqlInterval 实例的字符串表示。返回格式为：[M mon[s]] [d day[s]] [HH:mm:ss[.f[f[f[f[f[f[f[f[f]]]]]]]]]]。零值 NuxsqlInterval 表示为 00:00:00。计时周期为 100 纳秒，而 UXDB 的分辨率最高仅为 1µs，因此在数据库中存储值时会损失一位或多位小数精度。尽管如此，本方法仍会输出这一额外的精度位。它向前兼容未来分辨率提高到 100 纳秒的情况，也使该 ToString() 更适用于其他场景。
函数
```
string ToString()
```
参数：无。
返回值

字符串表示形式。

8.29.NuxsqlInet（网络地址类型）

8.29.1.addr

功能

地址
函数
```
IPAddress addr
```
参数：无。
返回值

返回/设置地址。

8.29.2.mask

功能

掩码
函数
```
int mask
```
参数：无。
返回值

返回/设置掩码。

8.29.3.NuxsqlInet

功能

构造函数
函数
```
NuxsqlInet(IPAddress addr, int mask)
```
参数

表 NuxsqlInet 参数说明

名称描述

addr（输入） IP 地址。

mask（输入）子网掩码位数。
返回值

返回一个 NuxsqlInet 对象。

8.29.4.NuxsqlInet

功能

构造函数
函数
```
NuxsqlInet(IPAddress addr)
```
参数

表 NuxsqlInet 参数说明

名称描述

addr（输入） IP 地址。
返回值

返回一个 NuxsqlInet 对象。

8.29.5.NuxsqlInet

功能

构造函数
函数
```
NuxsqlInet(string addr)
```
参数

表 NuxsqlInet 参数说明

名称描述

addr（输入） IP 地址。
返回值

返回一个 NuxsqlInet 对象。

8.29.6.ToString

功能

转换为字符串
函数
```
String ToString()
```
参数：无。
返回值

返回对象的字符串表示。

8.29.7.IPAddress

功能

IP 地址

函数

explicit operator IPAddress(NuxsqlInet x)

参数

表 IPAddress 参数说明

名称描述

x（输入）第一个比较对象。
返回值

返回IP 地址。

8.29.8.NuxsqlInet

功能

构造函数

函数

implicit operator NuxsqlInet(IPAddress ipaddress)

参数

表 NuxsqlInet 参数说明

名称描述

ipaddress（输入） IP 地址对象。
返回值

返回一个 NuxsqlInet 对象。

8.29.9.Equals

功能

判断是否与另一对象相等
函数
```
bool Equals(NuxsqlInet other)
```
参数

表 Equals 参数说明

名称描述

other（输入）另一个比较对象。
返回值

返回两个对象是否相等。

8.29.10.Equals

功能

判断是否与另一对象相等
函数
```
bool Equals(object obj)
```
参数

表 Equals 参数说明

名称描述

obj（输入）另一个对象。
返回值

返回两个对象是否相等。

8.29.11.GetHashCode

功能

获取对象的哈希码
函数
```
int GetHashCode()
```
参数：无。
返回值

返回对象的哈希码。

8.30.NuxsqlMacAddress（MAC 地址类型）

8.30.1.macAddr

功能

MAC 地址
函数
```
PhysicalAddress macAddr
```
参数：无。
返回值

返回/设置MAC 地址。

8.30.2.NuxsqlMacAddress

功能

构造函数

函数

NuxsqlMacAddress(PhysicalAddress macAddr)

参数

表 NuxsqlMacAddress 参数说明

名称	描述
macAddr（输入）	macAddr 参数必须只包含数字和大写字母形式的十六进制字符所组成的字符串（参见 MSDN 上的 PhysicalAddress.Parse 方法）。

返回值

返回一个 NuxsqlMacAddress 对象。

8.30.3.NuxsqlMacAddress

功能

构造函数
函数
```
NuxsqlMacAddress(string macAddr)
```

参数

表 NuxsqlMacAddress 参数说明

名称	描述
macAddr（输入）	macAddr 参数必须只包含数字和大写字母形式的十六进制字符所组成的字符串（参见 MSDN 上的 PhysicalAddress.Parse 方法）。

返回值

返回一个 NuxsqlMacAddress 对象。

8.30.4.ToString

功能

转换为字符串
函数
```
String ToString()
```
参数：无。
返回值

返回对象的字符串表示。

8.30.5.PhysicalAddress

功能

物理地址

函数

explicit operator PhysicalAddress(NuxsqlMacAddress x)

参数

表 PhysicalAddress 参数说明

名称描述

x（输入）第一个比较对象。
返回值

返回物理地址。

8.30.6.NuxsqlMacAddress

功能

构造函数

函数

implicit operator NuxsqlMacAddress(PhysicalAddress macAddr)

参数

表 NuxsqlMacAddress 参数说明

名称	描述
macAddr（输入）	macAddr 参数必须只包含数字和大写字母形式的十六进制字符所组成的字符串（参见 MSDN 上的 PhysicalAddress.Parse 方法）。

返回值

返回一个 NuxsqlMacAddress 对象。

8.30.7.Equals

功能

判断是否与另一对象相等
函数
```
bool Equals(NuxsqlMacAddress other)
```
参数

表 Equals 参数说明

名称描述

other（输入）另一个比较对象。
返回值

返回两个对象是否相等。

8.30.8.Equals

功能

判断是否与另一对象相等
函数
```
bool Equals(object obj)
```
参数

表 Equals 参数说明

名称描述

obj（输入）另一个对象。
返回值

返回两个对象是否相等。

8.30.9.GetHashCode

功能

获取对象的哈希码
函数
```
int GetHashCode()
```
参数：无。
返回值

返回对象的哈希码。

8.31.NuxsqlBox（矩形类型）

8.31.1.NuxsqlBox

功能

构造函数

函数

NuxsqlBox(NuxsqlPoint upperRight, NuxsqlPoint lowerLeft)

参数

表 NuxsqlBox 参数说明

名称描述

upperRight（输入）右上角点。

lowerLeft（输入）左下角点。
返回值

返回一个 NuxsqlBox 对象。

8.31.2.NuxsqlBox

功能

构造函数

函数

NuxsqlBox(float Top, float Right, float Bottom, float Left) : this(new NuxsqlPoint(Right, Top), new NuxsqlPoint(Left, Bottom))

参数

表 NuxsqlBox 参数说明

名称	描述
Top（输入）	上边界。
Right（输入）	右边界。
Bottom（输入）	下边界。
Left（输入）	左边界。

返回值

返回一个 NuxsqlBox 对象。

8.31.3.UpperRight

功能

获取上右
函数
```
NuxsqlPoint UpperRight
```
参数：无。
返回值

返回上右。

8.31.4.LowerLeft

功能

获取下左
函数
```
NuxsqlPoint LowerLeft
```
参数：无。
返回值

返回下左。

8.31.5.Left

功能

获取左
函数
```
float Left
```
参数：无。
返回值

返回左。

8.31.6.Right

功能

获取右
函数
```
float Right
```
参数：无。
返回值

返回右。

8.31.7.Bottom

功能

获取下边界
函数
```
float Bottom
```
参数：无。
返回值

返回下边界。

8.31.8.Top

功能

获取上边界
函数
```
float Top
```
参数：无。
返回值

返回上边界。

8.31.9.Width

功能

获取宽度
函数
```
float Width
```
参数：无。
返回值

返回宽度。

8.31.10.Height

功能

获取高度
函数
```
float Height
```
参数：无。
返回值

返回高度。

8.31.11.IsEmpty

功能

获取Is空
函数
```
bool IsEmpty
```
参数：无。
返回值

返回Is空。

8.31.12.Equals

功能

判断是否与另一对象相等
函数
```
bool Equals(NuxsqlBox other)
```
参数

表 Equals 参数说明

名称描述

other（输入）另一个比较对象。
返回值

返回两个对象是否相等。

8.31.13.Equals

功能

判断是否与另一对象相等
函数
```
bool Equals(object obj)
```
参数

表 Equals 参数说明

名称描述

obj（输入）另一个对象。
返回值

返回两个对象是否相等。

8.31.14.GetHashCode

功能

获取对象的哈希码
函数
```
int GetHashCode()
```
参数：无。
返回值

返回对象的哈希码。

8.32.NuxsqlCircle（圆类型）

8.32.1.Center

功能

中心
函数
```
NuxsqlPoint Center
```
参数：无。
返回值

返回/设置中心。

8.32.2.Radius

功能

半径
函数
```
Double Radius
```
参数：无。
返回值

返回/设置半径。

8.32.3.NuxsqlCircle

功能

构造函数

函数

NuxsqlCircle(NuxsqlPoint center, Double radius)

参数

表 NuxsqlCircle 参数说明

名称描述

center（输入）圆心。

radius（输入）半径。
返回值

返回一个 NuxsqlCircle 对象。

8.32.4.Equals

功能

判断是否与另一对象相等
函数
```
bool Equals(NuxsqlCircle other)
```
参数

表 Equals 参数说明

名称描述

other（输入）另一个比较对象。
返回值

返回两个对象是否相等。

8.32.5.Equals

功能

判断是否与另一对象相等
函数
```
bool Equals(object obj)
```
参数

表 Equals 参数说明

名称描述

obj（输入）另一个对象。
返回值

返回两个对象是否相等。

8.32.6.ToString

功能

转换为字符串
函数
```
String ToString()
```
参数：无。
返回值

返回对象的字符串表示。

8.32.7.GetHashCode

功能

获取对象的哈希码
函数
```
int GetHashCode()
```
参数：无。
返回值

返回对象的哈希码。

8.33.NuxsqlLSeg（线段类型）

8.33.1.Start

功能

起点
函数
```
NuxsqlPoint Start
```
参数：无。
返回值

返回/设置起点。

8.33.2.End

功能

终点
函数
```
NuxsqlPoint End
```
参数：无。
返回值

返回/设置终点。

8.33.3.NuxsqlLSeg

功能

构造函数

函数

NuxsqlLSeg(NuxsqlPoint start, NuxsqlPoint end)

参数

表 NuxsqlLSeg 参数说明

名称描述

start（输入）起点。

end（输入）终点。
返回值

返回一个 NuxsqlLSeg 对象。

8.33.4.ToString

功能

转换为字符串
函数
```
String ToString()
```
参数：无。
返回值

返回对象的字符串表示。

8.33.5.GetHashCode

功能

获取对象的哈希码
函数
```
int GetHashCode()
```
参数：无。
返回值

返回对象的哈希码。

8.33.6.Equals

功能

判断是否与另一对象相等
函数
```
bool Equals(NuxsqlLSeg other)
```
参数

表 Equals 参数说明

名称描述

other（输入）另一个比较对象。
返回值

返回两个对象是否相等。

8.33.7.Equals

功能

判断是否与另一对象相等
函数
```
bool Equals(object obj)
```
参数

表 Equals 参数说明

名称描述

obj（输入）另一个对象。
返回值

返回两个对象是否相等。

8.34.NuxsqlPath（路径类型）

8.34.1.NuxsqlPath

功能

构造函数

函数

NuxsqlPath(IEnumerable<NuxsqlPoint> points, bool open)

参数

表 NuxsqlPath 参数说明

名称描述

points（输入）点集合。

open（输入）是否开放路径。
返回值

返回一个 NuxsqlPath 对象。

8.34.2.NuxsqlPath

功能

构造函数

函数

NuxsqlPath(IEnumerable<NuxsqlPoint> points)

参数

表 NuxsqlPath 参数说明

名称描述

points（输入）点集合。
返回值

返回一个 NuxsqlPath 对象。

8.34.3.NuxsqlPath

功能

构造函数

函数

NuxsqlPath(NuxsqlPoint[] points) : this((IEnumerable<NuxsqlPoint>)points, false)

参数

表 NuxsqlPath 参数说明

名称描述

points（输入）点集合。
返回值

返回一个 NuxsqlPath 对象。

8.34.4.NuxsqlPath

功能

构造函数
函数
```
NuxsqlPath(bool open)
```
参数

表 NuxsqlPath 参数说明

名称描述

open（输入）是否开放路径。
返回值

返回一个 NuxsqlPath 对象。

8.34.5.NuxsqlPath

功能

构造函数
函数
```
NuxsqlPath(int capacity, bool open)
```
参数

表 NuxsqlPath 参数说明

名称描述

capacity（输入）初始容量。

open（输入）是否开放路径。
返回值

返回一个 NuxsqlPath 对象。

8.34.6.NuxsqlPath

功能

构造函数
函数
```
NuxsqlPath(int capacity)
```
参数

表 NuxsqlPath 参数说明

名称描述

capacity（输入）初始容量。
返回值

返回一个 NuxsqlPath 对象。

8.34.7.Open

功能

获取打开
函数
```
bool Open
```
参数：无。
返回值

返回打开。

8.34.8.this[索引器]

功能

按索引取元素
函数
```
NuxsqlPoint this[int index]
```
参数

表 this[索引器] 参数说明

名称描述

index（输入）序号（从 0 开始）。
返回值

返回当前行列值。

8.34.9.Count

功能

元素个数
函数
```
int Count
```
参数：无。
返回值

返回/设置元素个数。

8.34.10.IsReadOnly

功能

是否只读
函数
```
bool IsReadOnly
```
参数：无。
返回值

返回/设置是否只读。

8.34.11.IndexOf

功能

获取索引
函数
```
int IndexOf(NuxsqlPoint item)
```
参数

表 IndexOf 参数说明

名称描述

item（输入）集合元素。
返回值

返回对象在集合中的位置序号。

8.34.12.Insert

功能

插入

函数

void Insert(int index, NuxsqlPoint item)

参数

表 Insert 参数说明

名称描述

index（输入）位置序号。

item（输入）集合元素。
返回值

无返回值。

8.34.13.RemoveAt

功能

移除At
函数
```
void RemoveAt(int index)
```
参数

表 RemoveAt 参数说明

名称描述

index（输入）位置序号。
返回值

无返回值。

8.34.14.Add

功能

添加
函数
```
void Add(NuxsqlPoint item)
```
参数

表 Add 参数说明

名称描述

item（输入）集合元素。
返回值

无返回值。

8.34.15.Clear

功能

清空
函数
```
void Clear()
```
参数：无。
返回值

无返回值。

8.34.16.Contains

功能

判断是否包含
函数
```
bool Contains(NuxsqlPoint item)
```
参数

表 Contains 参数说明

名称描述

item（输入）集合元素。
返回值

返回是否包含指定对象。

8.34.17.CopyTo

功能

复制To

函数

void CopyTo(NuxsqlPoint[] array, int arrayIndex)

参数

表 CopyTo 参数说明

名称描述

array（输入）目标数组。

arrayIndex（输入）数组起始索引。
返回值

无返回值。

8.34.18.Remove

功能

移除
函数
```
bool Remove(NuxsqlPoint item)
```
参数

表 Remove 参数说明

名称描述

item（输入）集合元素。
返回值

返回移除。

8.34.19.GetEnumerator

功能

获取集合的遍历器

函数

IEnumerator<NuxsqlPoint> GetEnumerator()

参数：无。
返回值

返回集合的遍历器。

8.34.20.Equals

功能

判断是否与另一对象相等
函数
```
bool Equals(NuxsqlPath other)
```
参数

表 Equals 参数说明

名称描述

other（输入）另一个比较对象。
返回值

返回两个对象是否相等。

8.34.21.Equals

功能

判断是否与另一对象相等
函数
```
bool Equals(object obj)
```
参数

表 Equals 参数说明

名称描述

obj（输入）另一个对象。
返回值

返回两个对象是否相等。

8.34.22.GetHashCode

功能

获取对象的哈希码
函数
```
int GetHashCode()
```
参数：无。
返回值

返回对象的哈希码。

8.35.NuxsqlPoint（点类型）

8.35.1.NuxsqlPoint

功能

构造函数
函数
```
NuxsqlPoint(Single x, Single y)
```
参数

表 NuxsqlPoint 参数说明

名称描述

x（输入）第一个比较对象。

y（输入）第二个比较对象。
返回值

返回一个 NuxsqlPoint 对象。

8.35.2.X

功能

获取X
函数
```
Single X
```
参数：无。
返回值

返回X。

8.35.3.Y

功能

获取Y
函数
```
Single Y
```
参数：无。
返回值

返回Y。

8.35.4.Equals

功能

判断是否与另一对象相等
函数
```
bool Equals(NuxsqlPoint other)
```
参数

表 Equals 参数说明

名称描述

other（输入）另一个比较对象。
返回值

返回两个对象是否相等。

8.35.5.Equals

功能

判断是否与另一对象相等
函数
```
bool Equals(object obj)
```
参数

表 Equals 参数说明

名称描述

obj（输入）另一个对象。
返回值

返回两个对象是否相等。

8.35.6.GetHashCode

功能

获取对象的哈希码
函数
```
int GetHashCode()
```
参数：无。
返回值

返回对象的哈希码。

8.36.NuxsqlPolygon（多边形类型）

8.36.1.NuxsqlPolygon

功能

构造函数

函数

NuxsqlPolygon(IEnumerable<NuxsqlPoint> points)

参数

表 NuxsqlPolygon 参数说明

名称描述

points（输入）点集合。
返回值

返回一个 NuxsqlPolygon 对象。

8.36.2.NuxsqlPolygon

功能

构造函数

函数

NuxsqlPolygon(NuxsqlPoint[] points) : this ((IEnumerable<NuxsqlPoint>) points)

参数

表 NuxsqlPolygon 参数说明

名称描述

points（输入）点集合。
返回值

返回一个 NuxsqlPolygon 对象。

8.36.3.this[索引器]

功能

按索引取元素
函数
```
NuxsqlPoint this[int index]
```
参数

表 this[索引器] 参数说明

名称描述

index（输入）序号（从 0 开始）。
返回值

返回当前行列值。

8.36.4.Count

功能

元素个数
函数
```
int Count
```
参数：无。
返回值

返回/设置元素个数。

8.36.5.IsReadOnly

功能

是否只读
函数
```
bool IsReadOnly
```
参数：无。
返回值

返回/设置是否只读。

8.36.6.IndexOf

功能

获取索引
函数
```
int IndexOf(NuxsqlPoint item)
```
参数

表 IndexOf 参数说明

名称描述

item（输入）集合元素。
返回值

返回对象在集合中的位置序号。

8.36.7.Insert

功能

插入

函数

void Insert(int index, NuxsqlPoint item)

参数

表 Insert 参数说明

名称描述

index（输入）位置序号。

item（输入）集合元素。
返回值

无返回值。

8.36.8.RemoveAt

功能

移除At
函数
```
void RemoveAt(int index)
```
参数

表 RemoveAt 参数说明

名称描述

index（输入）位置序号。
返回值

无返回值。

8.36.9.Add

功能

添加
函数
```
void Add(NuxsqlPoint item)
```
参数

表 Add 参数说明

名称描述

item（输入）集合元素。
返回值

无返回值。

8.36.10.Clear

功能

清空
函数
```
void Clear()
```
参数：无。
返回值

无返回值。

8.36.11.Contains

功能

判断是否包含
函数
```
bool Contains(NuxsqlPoint item)
```
参数

表 Contains 参数说明

名称描述

item（输入）集合元素。
返回值

返回是否包含指定对象。

8.36.12.CopyTo

功能

复制To

函数

void CopyTo(NuxsqlPoint[] array, int arrayIndex)

参数

表 CopyTo 参数说明

名称描述

array（输入）目标数组。

arrayIndex（输入）数组起始索引。
返回值

无返回值。

8.36.13.Remove

功能

移除
函数
```
bool Remove(NuxsqlPoint item)
```
参数

表 Remove 参数说明

名称描述

item（输入）集合元素。
返回值

返回移除。

8.36.14.GetEnumerator

功能

获取集合的遍历器

函数

IEnumerator<NuxsqlPoint> GetEnumerator()

参数：无。
返回值

返回集合的遍历器。

8.36.15.Equals

功能

判断是否与另一对象相等
函数
```
bool Equals(NuxsqlPolygon other)
```
参数

表 Equals 参数说明

名称描述

other（输入）另一个比较对象。
返回值

返回两个对象是否相等。

8.36.16.Equals

功能

判断是否与另一对象相等
函数
```
bool Equals(object obj)
```
参数

表 Equals 参数说明

名称描述

obj（输入）另一个对象。
返回值

返回两个对象是否相等。

8.36.17.GetHashCode

功能

获取对象的哈希码
函数
```
int GetHashCode()
```
参数：无。
返回值

返回对象的哈希码。

8.37.BitString（变长位串类型）

8.37.1.Empty

功能

空

函数

BitString Empty = new BitString(new List<uint>(0), 0)

参数：无。
返回值

返回空。

8.37.2.BitString

功能

由一个布尔值序列创建 BitString。BitString 将按这些布尔值的传入顺序保存它们。
函数
```
BitString(IEnumerable<bool> bits)
```
参数

表 BitString 参数说明

名称描述

bits（输入）布尔值。
返回值

返回一个 BitString 对象。

8.37.3.BitString

功能

创建一个由指定数量的 true 或 false 值填充的 BitString。
函数
```
BitString(bool value, int count)
```
参数

表 BitString 参数说明

名称描述

value（输入）用于填充字符串的值。

count（输入）要填充的位数。
返回值

返回一个 BitString 对象。

8.37.4.BitString

功能

由一个布尔值序列创建 BitString。BitString 将按这些布尔值的传入顺序保存它们。
函数
```
BitString(string str)
```
参数

表 BitString 参数说明

名称描述

str（输入）要解析的字符串。
返回值

返回一个 BitString 对象。

8.37.5.BitString

功能

由一个布尔值序列创建 BitString。BitString 将按这些布尔值的传入顺序保存它们。
函数
```
BitString(bool boolean)
```
参数

表 BitString 参数说明

名称描述

boolean（输入）布尔值。
返回值

返回一个 BitString 对象。

8.37.6.BitString

功能

由一个布尔值序列创建 BitString。BitString 将按这些布尔值的传入顺序保存它们。
函数
```
BitString(uint integer)
```
参数

表 BitString 参数说明

名称描述

integer（输入）整数值。
返回值

返回一个 BitString 对象。

8.37.7.BitString

功能

由一个布尔值序列创建 BitString。BitString 将按这些布尔值的传入顺序保存它们。

函数

BitString(int integer) :this((uint)integer)

参数

表 BitString 参数说明

名称描述

integer（输入）整数值。
返回值

返回一个 BitString 对象。

8.37.8.Length

功能

字符串的长度。
函数
```
int Length
```
参数：无。
返回值

返回/设置长度。

8.37.9.this[索引器]

功能

按索引取元素
函数
```
bool this[int index]
```
参数

表 this[索引器] 参数说明

名称描述

index（输入）序号（从 0 开始）。
返回值

返回当前行列值。

8.37.10.IndexOf

功能

查找给定值第一次出现的位置。
函数
```
int IndexOf(bool item)
```
参数

表 IndexOf 参数说明

名称描述

item（输入）要搜索的值（true 或 false）。
返回值

所找到值的索引；若不存在则为 -1。

8.37.11.Contains

功能

若存在至少一个位等于所查找的值，则为 true。
函数
```
bool Contains(bool item)
```
参数

表 Contains 参数说明

名称描述

item（输入）要检测的值（true 或 false）。
返回值

若至少有一位与 item 相同则为 true，否则为 false。

8.37.12.CopyTo

功能

将位串复制到一个 bool 数组。

函数

void CopyTo(bool[] array, int arrayIndex)

参数

表 CopyTo 参数说明

名称描述

array（输入）要复制到的布尔数组。

arrayIndex（输入）数组中开始复制的起始索引。
返回值

无返回值。

8.37.13.GetEnumerator

功能

返回可用于遍历该字符串的枚举器。
函数
```
IEnumerator<bool> GetEnumerator()
```
参数：无。
返回值

枚举器。

8.37.14.Concat

功能

通过将另一个位串连接到当前位串之后来创建新位串。
函数
```
BitString Concat(BitString append)
```
参数

表 Concat 参数说明

名称描述

append（输入）要追加到当前字符串之后的字符串。
返回值

合并后的字符串。

8.37.15.Substring

功能

返回当前字符串的子串。

函数

BitString Substring(int start, int length)

参数

表 Substring 参数说明

名称	描述
start（输入）	起始位置，必须介于 0 与字符串长度之间。
length（输入）	要返回的字符串长度，必须大于零，且 start + length 不得超出当前实例的边界。

返回值

所标识的位串。

8.37.16.Substring

功能

返回当前字符串的子串。
函数
```
BitString Substring(int start)
```
参数

表 Substring 参数说明

名称描述

start（输入）起始位置，必须介于 0 与字符串长度之间；返回字符串的其余部分。
返回值

所标识的位串。

8.37.17.And

功能

当前字符串与另一个字符串的逻辑与。两个字符串长度必须相同。
函数
```
BitString And(BitString operand)
```
参数

表 And 参数说明

名称描述

operand（输入）与当前 BitString 执行按位与运算的另一个 BitString。
返回值

按位与的结果位串：两个位串对应位均为 1 时为 1，否则为 0。

8.37.18.Or

功能

当前字符串与另一个字符串的逻辑或。两个字符串长度必须相同。
函数
```
BitString Or(BitString operand)
```
参数

表 Or 参数说明

名称描述

operand（输入）与当前 BitString 执行按位或运算的另一个 BitString。
返回值

按位或的结果位串：任一位串对应位为 1 时为 1，否则为 0。

8.37.19.Xor

功能

当前字符串与另一个字符串的逻辑异或。两个字符串长度必须相同。
函数
```
BitString Xor(BitString operand)
```
参数

表 Xor 参数说明

名称描述

operand（输入）与当前 BitString 执行按位异或运算的另一个 BitString。
返回值

按位异或的结果位串：两个位串对应位不同时为 1，同为 1 或同为 0 时为 0。

8.37.20.Not

功能

当前位串按位取反后得到的位串。
函数
```
BitString Not()
```
参数：无。
返回值

与当前位串长度相同、按位取反后的位串（当前为 0 的位置为 1，反之亦然）。

8.37.21.LShift

功能

将字符串操作数的位左移，补零以生成长度相同的字符串。
函数
```
BitString LShift(int operand)
```
参数

表 LShift 参数说明

名称描述

operand（输入）左移的位数。
返回值

左移后的位串。

8.37.22.RShift

功能

将字符串操作数的位右移，补零以生成长度相同的字符串。
函数
```
BitString RShift(int operand)
```
参数

表 RShift 参数说明

名称描述

operand（输入）右移的位数。
返回值

右移后的位串。

8.37.23.Equals

功能

若该字符串与传入的参数完全相同，则返回 true。
函数
```
bool Equals(BitString other)
```
参数

表 Equals 参数说明

名称描述

other（输入）另一个比较对象。
返回值

返回两个对象是否相等。

8.37.24.CompareTo

功能

比较两个字符串。字符串按字符串方式比较：长度相同时，由于 0 小于 1，比较结果与按数值比较一致；长度不同时，从最右侧（最高有效位）开始比较，若较短字符串的所有位都比较完仍未得出结果，则较长的字符串视为大于较短的（0010 大于 0001，但小于 00100）。
函数
```
int CompareTo(BitString other)
```
参数

表 CompareTo 参数说明

名称描述

other（输入）与当前字符串比较的另一个字符串。
返回值

若两个字符串相同则返回 0；若当前字符串小于参数则返回小于 0 的整数；否则返回大于 0 的整数。

8.37.25.CompareTo

功能

比较两个字符串。字符串按字符串方式比较：长度相同时，由于 0 小于 1，比较结果与按数值比较一致；长度不同时，从最右侧（最高有效位）开始比较，若较短字符串的所有位都比较完仍未得出结果，则较长的字符串视为大于较短的（0010 大于 0001，但小于 00100）。
函数
```
int CompareTo(object obj)
```
参数

表 CompareTo 参数说明

名称描述

obj（输入）另一个对象。
返回值

若两个字符串相同则返回 0；若当前字符串小于参数则返回小于 0 的整数；否则返回大于 0 的整数。

8.37.26.Equals

功能

若该字符串与传入的参数完全相同，则返回 true。
函数
```
bool Equals(object obj)
```
参数

表 Equals 参数说明

名称描述

obj（输入）另一个对象。
返回值

返回两个对象是否相等。

8.37.27.GetHashCode

功能

返回用于哈希运算的代码。
函数
```
int GetHashCode()
```
参数：无。
返回值

返回对象的哈希码。

8.37.28.ToString

功能

返回该 BitString 的字符串表示。
函数
```
string ToString(string format)
```

参数

表 ToString 参数说明

名称

描述

format（输入）

用于指定返回字符串形式的字符串，可包含一个字母及一个可选数字，数字用于设置返回字符串的最小长度；字母使用小写形式时返回小写字符串。B：由 0 和 1 组成的字符串。X：十六进制字符串（字符串长度不能被 4 整除时将报错）。G：单引号内由 0、1 组成并以 'B' 开头的字符串（UXDB 位串字面量语法）。Y：单引号内十六进制字符串并以 'X' 开头（UXDB 位串字面量语法，长度不能被 4 整除时将报错）。C：若合法则采用格式 “Y” 产生的表示，否则采用格式 “G”。E：UXDB 最紧凑的安全表示；只有单个位时为 0 或 1；否则优先采用 “Y”，长度不足 9 位则采用 “G”；更长且无法用十六进制表示时，前半部分采用 “Y”、后接 UXDB 连接运算符、剩余位采用 “G”，例如 “X'13DCE'||B'110'”。若 format 为空或 null，则视为传入 “B”（默认表示，也是 UXDB 通常显示所用的表示）。

返回值

格式化后的字符串。

8.37.29.ToString

功能

返回该位串的字符串表示。
函数
```
string ToString()
```
参数：无。
返回值

由字符 '0' 和 '1' 组成的字符串。

8.37.30.ToString

功能

返回与 ToString(String) 相同的字符串。formatProvider 被忽略。

函数

string ToString(string format, IFormatProvider formatProvider)

参数

表 ToString 参数说明

名称描述

format（输入）格式字符串。

formatProvider（输入）格式提供程序。
返回值

返回对象的字符串表示。

8.37.31.Parse

功能

解析字符串以生成 BitString。可接受 ToString(String) 能产生的大多数格式；十六进制可用前置的 X' 标记后续字符为十六进制而非二进制。
函数
```
BitString Parse(string text)
```
参数

表 Parse 参数说明

名称描述

text（输入）要解析的文本。
返回值

返回解析得到的对象。

8.37.32.GetTypeCode

功能

获取类型代码
函数
```
TypeCode GetTypeCode()
```
参数：无。
返回值

返回类型代码。

8.37.33.ToBoolean

功能

转换为布尔
函数
```
bool ToBoolean()
```
参数：无。
返回值

返回转换后的布尔值。

8.37.34.ToBoolean

功能

转换为布尔

函数

bool ToBoolean(IFormatProvider provider)

参数

表 ToBoolean 参数说明

名称描述

provider（输入）格式提供程序。
返回值

返回转换后的布尔值。

8.37.35.ToSByte

功能

ToS字节
函数
```
sbyte ToSByte()
```
参数：无。
返回值

返回转换后的有符号字节。

8.37.36.ToSByte

功能

ToS字节

函数

sbyte ToSByte(IFormatProvider provider)

参数

表 ToSByte 参数说明

名称描述

provider（输入）格式提供程序。
返回值

返回转换后的有符号字节。

8.37.37.ToByte

功能

转换为字节
函数
```
byte ToByte()
```
参数：无。
返回值

返回转换后的字节。

8.37.38.ToByte

功能

转换为字节
函数
```
byte ToByte(IFormatProvider provider)
```
参数

表 ToByte 参数说明

名称描述

provider（输入）格式提供程序。
返回值

返回转换后的字节。

8.37.39.ToInt16

功能

转换为16 位整数
函数
```
short ToInt16()
```
参数：无。
返回值

返回转换后的 16 位整数。

8.37.40.ToInt16

功能

转换为16 位整数

函数

short ToInt16(IFormatProvider provider)

参数

表 ToInt16 参数说明

名称描述

provider（输入）格式提供程序。
返回值

返回转换后的 16 位整数。

8.37.41.ToUInt16

功能

转换为16 位无符号整数
函数
```
ushort ToUInt16()
```
参数：无。
返回值

返回转换后的 16 位无符号整数。

8.37.42.ToUInt16

功能

转换为16 位无符号整数

函数

ushort ToUInt16(IFormatProvider provider)

参数

表 ToUInt16 参数说明

名称描述

provider（输入）格式提供程序。
返回值

返回转换后的 16 位无符号整数。

8.37.43.ToInt32

功能

转换为32 位整数
函数
```
int ToInt32()
```
参数：无。
返回值

返回转换后的 32 位整数。

8.37.44.ToInt32

功能

转换为32 位整数
函数
```
int ToInt32(IFormatProvider provider)
```
参数

表 ToInt32 参数说明

名称描述

provider（输入）格式提供程序。
返回值

返回转换后的 32 位整数。

8.37.45.ToUInt32

功能

转换为32 位无符号整数
函数
```
uint ToUInt32()
```
参数：无。
返回值

返回转换后的 32 位无符号整数。

8.37.46.ToUInt32

功能

转换为32 位无符号整数

函数

uint ToUInt32(IFormatProvider provider)

参数

表 ToUInt32 参数说明

名称描述

provider（输入）格式提供程序。
返回值

返回转换后的 32 位无符号整数。

8.37.47.ToInt64

功能

转换为64 位整数
函数
```
long ToInt64()
```
参数：无。
返回值

返回转换后的 64 位整数。

8.37.48.ToInt64

功能

转换为64 位整数
函数
```
long ToInt64(IFormatProvider provider)
```
参数

表 ToInt64 参数说明

名称描述

provider（输入）格式提供程序。
返回值

返回转换后的 64 位整数。

8.37.49.ToUInt64

功能

转换为64 位无符号整数
函数
```
ulong ToUInt64()
```
参数：无。
返回值

返回转换后的 64 位无符号整数。

8.37.50.ToUInt64

功能

转换为64 位无符号整数

函数

ulong ToUInt64(IFormatProvider provider)

参数

表 ToUInt64 参数说明

名称描述

provider（输入）格式提供程序。
返回值

返回转换后的 64 位无符号整数。

8.37.51.ToString

功能

返回该 BitString 的字符串表示。

函数

string ToString(IFormatProvider provider)

参数

表 ToString 参数说明

名称描述

provider（输入）格式提供程序。
返回值

格式化后的字符串。

8.37.52.ToString

功能

将位串解释为按传入 Encoding 编码的字符串中的位序列，并返回该字符串。位串必须包含整数个八位字节（字节），且按传入的 Encoding 有效。
函数
```
string ToString(Encoding encoding)
```
参数

表 ToString 参数说明

名称描述

encoding（输入）生成字符串时使用的编码。
返回值

以 BitString 编码的字符串。

8.37.53.ToByteEnumerable

功能

将位串解释为一系列八位字节（字节）并返回这些字节。若位串不包含整数个字节（即长度不能被 8 整除）则失败。
函数
```
IEnumerable<byte> ToByteEnumerable()
```
参数：无。
返回值

返回字节可枚举集合。

8.37.54.ToSByteEnumerable

功能

将位串解释为一系列有符号八位字节（字节）并返回。若位串不包含整数个字节（长度不能被 8 整除）则失败。此方法不符合 CLS，对于无法处理有符号字节的语言可能不可用。
函数
```
IEnumerable<sbyte> ToSByteEnumerable()
```
参数：无。
返回值

返回有符号字节可枚举集合。

8.37.55.ToUInt16Enumerable

功能

将位串解释为一系列无符号 16 位整数并返回这些整数。若位串长度不能被 16 整除则失败。此方法不符合 CLS，对于无法处理无符号整数的语言可能不可用。

函数

IEnumerable<ushort> ToUInt16Enumerable()

参数：无。
返回值

返回无符号 16 位整数可枚举集合。

8.37.56.ToInt16Enumerable

功能

将位串解释为一系列 16 位整数并返回这些整数。若位串长度不能被 16 整除则失败。
函数
```
IEnumerable<short> ToInt16Enumerable()
```
参数：无。
返回值

返回 16 位整数可枚举集合。

8.37.57.ToUInt32Enumerable

功能

将位串解释为一系列无符号 32 位整数并返回这些整数。若位串长度不能被 32 整除则失败。此方法不符合 CLS，对于无法处理无符号整数的语言可能不可用。
函数
```
IEnumerable<uint> ToUInt32Enumerable()
```
参数：无。
返回值

返回无符号 32 位整数可枚举集合。

8.37.58.ToInt32Enumerable

功能

将位串解释为一系列有符号 32 位整数并返回这些整数。若位串长度不能被 32 整除则失败。
函数
```
IEnumerable<int> ToInt32Enumerable()
```
参数：无。
返回值

返回 32 位整数可枚举集合。

8.37.59.ToUInt64Enumerable

功能

将位串解释为一系列无符号 64 位整数并返回这些整数。若位串长度不能被 64 整除则失败。此方法不符合 CLS，对于无法处理无符号整数的语言可能不可用。

函数

IEnumerable<ulong> ToUInt64Enumerable()

参数：无。
返回值

返回无符号 64 位整数可枚举集合。

8.37.60.ToInt64Enumerable

功能

将位串解释为一系列有符号 64 位整数并返回这些整数。若位串长度不能被 64 整除则失败。
函数
```
IEnumerable<long> ToInt64Enumerable()
```
参数：无。
返回值

返回 64 位整数可枚举集合。

8.37.61.ToType

功能

转换为类型

函数

object ToType(Type conversionType, IFormatProvider provider)

参数

表 ToType 参数说明

名称描述

conversionType（输入）目标类型。

provider（输入）格式提供程序。
返回值

返回转换后的对象。

8.38.ProtocolVersion（协议版本枚举）

8.38.1.Unknown

功能

未知类型
函数
```
枚举取值 0
```
参数：无。
返回值

取值为 0。

8.38.2.Version3

功能

协议版本 3
函数
```
枚举取值 3
```
参数：无。
返回值

取值为 3。

8.39.SslMode（SSL 连接模式枚举）

8.39.1.Disable

功能

禁用 SSL。若服务器要求使用 SSL，连接将失败。
函数
```
枚举取值 1 << 0
```
参数：无。
返回值

取值为 1 << 0。

8.39.2.Allow

功能

允许
函数
```
枚举取值 1 << 1
```
参数：无。
返回值

取值为 1 << 1。

8.39.3.Prefer

功能

若服务器允许则优先使用 SSL 连接，但也允许不使用 SSL 的连接。
函数
```
枚举取值 1 << 2
```
参数：无。
返回值

取值为 1 << 2。

8.39.4.Require

功能

若服务器不支持 SSL，则连接失败。
函数
```
枚举取值 1 << 3
```
参数：无。
返回值

取值为 1 << 3。

8.40.ServerVersion（服务端版本号解析）

8.40.1.ProtocolVersion2

功能

协议版本 2常量
函数
```
Int32 ProtocolVersion2 = 2 << 16
```
参数：无。
返回值

返回协议版本 2常量。

8.40.2.ProtocolVersion3

功能

协议版本 3常量
函数
```
Int32 ProtocolVersion3 = 3 << 16
```
参数：无。
返回值

返回协议版本 3常量。

8.40.3.Major

功能

服务器版本主版本号。
函数
```
Int32 Major
```
参数：无。
返回值

返回主版本号。

8.40.4.Minor

功能

服务器版本次版本号。
函数
```
Int32 Minor
```
参数：无。
返回值

返回次版本号。

8.40.5.Patch

功能

服务器版本补丁级别号。
函数
```
Int32 Patch
```
参数：无。
返回值

返回修订号。

8.40.6.Version

功能

版本

函数

implicit operator Version(ServerVersion sv)

参数

表 Version 参数说明

名称描述

sv（输入）服务端版本对象。
返回值

返回版本。

8.40.7.ServerVersion

功能

构造函数

函数

implicit operator ServerVersion(Version ver)

参数

表 ServerVersion 参数说明

名称描述

ver（输入）版本对象。
返回值

返回一个 ServerVersion 对象。

8.40.8.Equals

功能

判断是否与另一对象相等
函数
```
bool Equals(ServerVersion other)
```
参数

表 Equals 参数说明

名称描述

other（输入）另一个比较对象。
返回值

返回两个对象是否相等。

8.40.9.CompareTo

功能

与另一对象比较大小
函数
```
int CompareTo(ServerVersion other)
```
参数

表 CompareTo 参数说明

名称描述

other（输入）另一个比较对象。
返回值

返回比较结果（小于、等于或大于）。

8.40.10.CompareTo

功能

与另一对象比较大小
函数
```
int CompareTo(object obj)
```
参数

表 CompareTo 参数说明

名称描述

obj（输入）另一个对象。
返回值

返回比较结果（小于、等于或大于）。

8.40.11.Clone

功能

克隆
函数
```
object Clone()
```
参数：无。
返回值

返回克隆后的对象。

8.40.12.Equals

功能

判断是否与另一对象相等
函数
```
bool Equals(object O)
```
参数

表 Equals 参数说明

名称描述

O（输入）另一个比较对象。
返回值

返回两个对象是否相等。

8.40.13.GetHashCode

功能

获取对象的哈希码
函数
```
int GetHashCode()
```
参数：无。
返回值

返回对象的哈希码。

8.40.14.ToString

功能

以三段点分格式（Major.Minor.Patch）返回该版本的字符串表示。
函数
```
String ToString()
```
参数：无。
返回值

返回对象的字符串表示。

8.41.ServerVersionCode（服务端版本代号枚举）

8.41.1.ProtocolVersion3

功能

协议版本 3
函数
```
枚举取值 3 << 16 // 196608
```
参数：无。
返回值

取值为 3 << 16。

8.42.LogLevel（日志级别枚举）

8.42.1.None

功能

完全不记录日志。
函数
```
枚举取值 0
```
参数：无。
返回值

取值为 0。

8.42.2.Normal

功能

仅记录最常见的问题。
函数
```
枚举取值 1
```
参数：无。
返回值

取值为 1。

8.42.3.Debug

功能

记录所有内容。
函数
```
枚举取值 2
```
参数：无。
返回值

取值为 2。

8.43.NuxsqlCommandBuilder（命令构建器（DbCommandBuilder），可自动生成 INSERT/UPDATE/DELETE 命令）

8.43.1.NuxsqlCommandBuilder

功能

初始化 NuxsqlCommandBuilder 类的新实例。
函数
```
NuxsqlCommandBuilder()
```
参数：无。
返回值

返回一个 NuxsqlCommandBuilder 对象。

8.43.2.NuxsqlCommandBuilder

功能

初始化 NuxsqlCommandBuilder 类的新实例。

函数

NuxsqlCommandBuilder(NuxsqlDataAdapter adapter)

参数

表 NuxsqlCommandBuilder 参数说明

名称描述

adapter（输入）数据适配器。
返回值

返回一个 NuxsqlCommandBuilder 对象。

8.43.3.QuotePrefix

功能

获取或设置起始字符（可为一个或多个），用于指定名称中包含空格或保留字等字符的数据库对象（例如表或列）。
函数
```
string QuotePrefix
```
参数：无。
返回值

要使用的起始字符（可为一个或多个字符）。默认为空字符串。

8.43.4.QuoteSuffix

功能

获取或设置结束字符（可为一个或多个），用于指定名称中包含空格或保留字等字符的数据库对象（例如表或列）。
函数
```
string QuoteSuffix
```
参数：无。
返回值

要使用的结束字符（可为一个或多个字符）。默认为空字符串。

8.43.5.DeriveParameters

功能

该方法负责根据函数定义获取的值推导命令参数列表。它会清空命令的 Parameters 集合。此外，若存在 Nuxsql 不支持的参数类型，将抛出 InvalidOperationException。参数名将为 parameter1、parameter2……

函数

void DeriveParameters(NuxsqlCommand command)

参数

表 DeriveParameters 参数说明

名称描述

command（输入）要获取其函数参数的 NuxsqlCommand。
返回值

无返回值。

8.43.6.GetInsertCommand

功能

获取在数据源执行插入操作所需的自动生成的 NuxsqlCommand 对象。
函数
```
NuxsqlCommand GetInsertCommand()
```
参数：无。
返回值

执行插入操作所需的自动生成的 NuxsqlCommand 对象。

8.43.7.GetInsertCommand

功能

获取在数据源执行插入操作所需的自动生成的 NuxsqlCommand 对象，可选择使用列名作为参数名。

函数

NuxsqlCommand GetInsertCommand(bool useColumnsForParameterNames)

参数

表 GetInsertCommand 参数说明

名称	描述
useColumnsForParameterNames（输入）	若为 true，则尽可能生成与列名一致的参数名；若为 false，则生成 @p1、@p2 等形式的参数名。

返回值

执行插入操作所需的自动生成的 NuxsqlCommand 对象。

8.43.8.GetUpdateCommand

功能

获取在数据源执行更新操作所需的自动生成的 System.Data.Common.DbCommand 对象。
函数
```
NuxsqlCommand GetUpdateCommand()
```
参数：无。
返回值

执行更新操作所需的自动生成的 System.Data.Common.DbCommand 对象。

8.43.9.GetUpdateCommand

功能

获取在数据源执行更新操作所需的自动生成的 NuxsqlCommand 对象，可选择使用列名作为参数名。

函数

NuxsqlCommand GetUpdateCommand(bool useColumnsForParameterNames)

参数

表 GetUpdateCommand 参数说明

名称	描述
useColumnsForParameterNames（输入）	若为 true，则尽可能生成与列名一致的参数名；若为 false，则生成 @p1、@p2 等形式的参数名。

返回值

执行更新操作所需的自动生成的 NuxsqlCommand 对象。

8.43.10.GetDeleteCommand

功能

获取在数据源执行删除操作所需的自动生成的 System.Data.Common.DbCommand 对象。
函数
```
NuxsqlCommand GetDeleteCommand()
```
参数：无。
返回值

执行删除操作所需的自动生成的 System.Data.Common.DbCommand 对象。

8.43.11.GetDeleteCommand

功能

获取在数据源执行删除操作所需的自动生成的 NuxsqlCommand 对象，可选择使用列名作为参数名。

函数

NuxsqlCommand GetDeleteCommand(bool useColumnsForParameterNames)

参数

表 GetDeleteCommand 参数说明

名称	描述
useColumnsForParameterNames（输入）	若为 true，则尽可能生成与列名一致的参数名；若为 false，则生成 @p1、@p2 等形式的参数名。

返回值

执行删除操作所需的自动生成的 NuxsqlCommand 对象。

8.43.12.QuoteIdentifier

功能

给定一个大小写符合目录要求的未加引号标识符，返回其正确的加引号形式，包括正确转义标识符中内嵌的引号。

函数

string QuoteIdentifier(string unquotedIdentifier)

参数

表 QuoteIdentifier 参数说明

名称描述

unquotedIdentifier（输入）原始的、未加引号的标识符。
返回值

加引号后的标识符，标识符中内嵌的引号已正确转义。

8.43.13.UnquoteIdentifier

功能

给定一个加引号的标识符，返回其正确的去引号形式，包括正确反转义标识符中内嵌的引号。

函数

string UnquoteIdentifier(string quotedIdentifier)

参数

表 UnquoteIdentifier 参数说明

名称描述

quotedIdentifier（输入）要去除内嵌引号的标识符。
返回值

去除引号的标识符，其中内嵌的引号已正确反转义。

8.44.LargeObject（大对象（LOB）读写操作）

8.44.1.SEEK_SET

功能

表示从文件起始处开始定位。
函数
```
Int32 SEEK_SET = 0
```
参数：无。
返回值

返回定位SET常量。

8.44.2.SEEK_CUR

功能

表示从当前位置开始定位。
函数
```
Int32 SEEK_CUR = 1
```
参数：无。
返回值

返回定位CUR常量。

8.44.3.SEEK_END

功能

表示从文件末尾开始定位。
函数
```
Int32 SEEK_END = 2
```
参数：无。
返回值

返回定位终点常量。

8.44.4.LargeObject

功能

打开一个大对象。若该对象不存在，则抛出 NuxsqlException。

函数

LargeObject(Fastpath fp, Int32 oid, Int32 mode)

参数

表 LargeObject 参数说明

名称	描述
fp（输入）	该连接使用的 FastPath API。
oid（输入）	要打开的大对象的 OID。
mode（输入）	打开大对象的模式。

返回值

返回一个 LargeObject 对象。

8.44.5.GetOID

功能

获取 OID。
函数
```
Int32 GetOID()
```
参数：无。
返回值

该 LargeObject 的 OID。

8.44.6.OID

功能

对象标识符（OID）。
函数
```
Int32 OID
```
参数：无。
返回值

返回对象标识。

8.44.7.Close

功能

该方法关闭对象。调用后不得再调用该对象的任何方法。
函数
```
void Close()
```
参数：无。
返回值

无返回值。

8.44.8.Read

功能

从对象读取部分数据，并以 byte[] 数组形式返回。
函数
```
Byte[] Read(Int32 len)
```
参数

表 Read 参数说明

名称描述

len（输入）要读取的字节数。
返回值

包含所读取数据的数组。

8.44.9.Read

功能

从对象读取部分数据到已有的数组中。

函数

Int32 Read(Byte[] buf, Int32 off, Int32 len)

参数

表 Read 参数说明

名称描述

buf（输入）目标数组。

off（输入）数组内的偏移量。

len（输入）要读取的最大字节数。
返回值

实际读取的字节数。

8.44.10.Write

功能

将数组写入对象。
函数
```
void Write(Byte[] buf)
```
参数

表 Write 参数说明

名称描述

buf（输入）要写入的数组。
返回值

无返回值。

8.44.11.Write

功能

将数组中的部分数据写入对象。

函数

void Write(Byte[] buf, Int32 off, Int32 len)

参数

表 Write 参数说明

名称描述

buf（输入）目标数组。

off（输入）数组内的偏移量。

len（输入）要写入的字节数。
返回值

无返回值。

8.44.12.Seek

功能

设置对象内的当前位置。这类似于标准 C 库中的 fseek() 调用，可用于对大对象进行随机访问。
函数
```
void Seek(Int32 pos, Int32 refi)
```
参数

表 Seek 参数说明

名称描述

pos（输入）对象内的位置。

refi（输入）取值为 SEEK_SET、SEEK_CUR 或 SEEK_END 之一。
返回值

无返回值。

8.44.13.Seek

功能

设置对象内的当前位置。这类似于标准 C 库中的 fseek() 调用，可用于对大对象进行随机访问。
函数
```
void Seek(Int32 pos)
```
参数

表 Seek 参数说明

名称描述

pos（输入）对象内从起始处开始计算的位置。
返回值

无返回值。

8.44.14.Tell

功能

报告对象内的当前位置。
函数
```
Int32 Tell()
```
参数：无。
返回值

对象内的当前位置。

8.44.15.Size

功能

该方法效率较低，因为获知对象大小的唯一方式是定位到末尾、记录当前位置，再返回到原位置。将来会找到更好的方法。
函数
```
Int32 Size()
```
参数：无。
返回值

大对象的大小。

8.45.LargeObjectManager（大对象（LOB）管理器）

8.45.1.WRITE

功能

该模式表示要写入一个对象。
函数
```
Int32 WRITE = 0x00020000
```
参数：无。
返回值

返回只写访问模式常量。

8.45.2.READ

功能

该模式表示要读取一个对象。
函数
```
Int32 READ = 0x00040000
```
参数：无。
返回值

返回只读访问模式常量。

8.45.3.READWRITE

功能

该模式为默认模式，表示需要对对象进行读写访问。
函数
```
Int32 READWRITE = READ | WRITE
```
参数：无。
返回值

返回读写访问模式常量。

8.45.4.LargeObjectManager

功能

构造 LargeObject API。每个连接应只存在一个 LargeObjectManager。org.UXDB.Connection 类负责管理各类扩展 API，建议通过它来获取访问，而不要直接调用。

函数

LargeObjectManager(NuxsqlConnection conn)

参数

表 LargeObjectManager 参数说明

名称描述

conn（输入）连接对象。
返回值

返回一个 LargeObjectManager 对象。

8.45.5.Open

功能

根据 OID 打开一个已存在的大对象。该方法假定需要 READ 和 WRITE 访问权限（默认值）。
函数
```
LargeObject Open(Int32 oid)
```
参数

表 Open 参数说明

名称描述

oid（输入）大对象的 OID。
返回值

提供该对象访问能力的 LargeObject 实例。

8.45.6.Open

功能

根据 OID 打开一个已存在的大对象。

函数

LargeObject Open(Int32 oid, Int32 mode)

参数

表 Open 参数说明

名称描述

oid（输入）大对象的 OID。

mode（输入）打开模式。
返回值

返回打开。

8.45.7.Create

功能

创建一个大对象，并返回其 OID。
函数
```
Int32 Create()
```
参数：无。
返回值

新建对象的 OID。

8.45.8.Create

功能

创建一个大对象，并返回其 OID。
函数
```
Int32 Create(Int32 mode)
```
参数

表 Create 参数说明

名称描述

mode（输入）描述新建对象各项属性的位掩码。
返回值

新建对象的 OID。

8.45.9.Delete

功能

删除一个大对象。
函数
```
void Delete(Int32 oid)
```
参数

表 Delete 参数说明

名称描述

oid（输入）待删除对象的 OID。
返回值

无返回值。

8.45.10.Unlink

功能

删除一个大对象。它与 Delete() 方法完全相同，提供此方法是因为 C API 使用的是 unlink。
函数
```
void Unlink(Int32 oid)
```
参数

表 Unlink 参数说明

名称描述

oid（输入）待删除对象的 OID。
返回值

无返回值。

名称	描述
array（输入）	用于复制集合中 NuxsqlParameter 对象的目标数组。
index（输入）	数组的起始索引。

名称	描述
index（输入）	参数插入到集合中的从零开始的索引位置。
item（输入）	集合元素。

名称	描述
array（输入）	用于复制集合中 NuxsqlParameter 对象的目标数组。
arrayIndex（输入）	数组起始索引。

名称	描述
info（输入）	序列化信息对象。
context（输入）	流上下文对象。

名称	描述
keyword（输入）	要获取的项的键。
value（输出）	与该键对应的值。

名称	描述
copyInQuery（输入）	COPY 导入查询语句。
conn（输入）	连接对象。

名称	描述
cmd（输入）	命令对象。
conn（输入）	连接对象。

名称	描述
copyOutQuery（输入）	COPY 导出查询语句。
conn（输入）	连接对象。

名称	描述
str（输入）	要解析的字符串。
date（输出）	解析得到的日期对象。

名称	描述
x（输入）	第一个比较对象。
y（输入）	第二个比较对象。

名称	描述
str（输入）	要解析的字符串。
time（输出）	解析得到的时间对象。

名称	描述
localTime（输入）	本地时间。
timeZone（输入）	时区对象。

名称	描述
ticks（输入）	时钟周期数。
timeZone（输入）	时区对象。

名称	描述
time（输入）	时间对象。
timeZone（输入）	时区对象。

名称	描述
date（输入）	日期对象。
time（输入）	时间对象。

名称	描述
timeZoneFrom（输入）	起始时区。
timeZoneTo（输入）	目标时区。

名称	描述
str（输入）	要解析的字符串。
tz（输入）	时区对象。

名称	描述
x（输入）	第一个 NuxsqlInterval。
y（输入）	第二个 NuxsqlInterval。

名称	描述
addr（输入）	IP 地址。
mask（输入）	子网掩码位数。

名称	描述
upperRight（输入）	右上角点。
lowerLeft（输入）	左下角点。

名称	描述
points（输入）	点集合。
open（输入）	是否开放路径。

名称	描述
capacity（输入）	初始容量。
open（输入）	是否开放路径。

名称	描述
array（输入）	目标数组。
arrayIndex（输入）	数组起始索引。

名称	描述
value（输入）	用于填充字符串的值。
count（输入）	要填充的位数。

名称	描述
array（输入）	要复制到的布尔数组。
arrayIndex（输入）	数组中开始复制的起始索引。

名称	描述
format（输入）	格式字符串。
formatProvider（输入）	格式提供程序。

名称	描述
conversionType（输入）	目标类型。
provider（输入）	格式提供程序。

名称	描述
buf（输入）	目标数组。
off（输入）	数组内的偏移量。
len（输入）	要读取的最大字节数。

名称	描述
pos（输入）	对象内的位置。
refi（输入）	取值为 SEEK_SET、SEEK_CUR 或 SEEK_END 之一。

名称	描述
oid（输入）	大对象的 OID。
mode（输入）	打开模式。