附录1：主要接口

主要接口说明如下：

• Xorm.NewEngine()

  此方法用于创建新的数据库会话并返回新的connection对象。参数说明如下：

  关键字	参数说明
  dbname	数据库名称
  user	用户名
  password	密码
  host	数据库所在主机IP地址
  port	连接端口号，默认为5432
  sslmode	ssl模式，ssl连接时用
  sslcert	客户端证书路径，ssl连接时用
  sslkey	客户端秘钥路径，ssl连接时用
  sslrootcert	根证书路径，ssl连接时用

  返回值说明如下：

  关键字	参数说明
  engine	ORM引擎
  err	报错信息

  调用示例见附录2。

• engine.Exec()

  此方法执行一个SQL命令。此时不管数据库是何种类型，都可以使用 ` 和 ? 符号。参数说明如下：

  关键字	参数说明
  query	待执行的sql语句
  vars_list	变量列表，匹配query中?为占位符

  返回值说明如下：

  关键字	参数说明
  affected	结果影响行数
  err	报错信息

  调用示例见附录2。

• engine.Query()

  此方法执行一个SQL查询，即Select命令。在vastbase中支持原始SQL语句中使用 ` 和 ? 符号。参数说明如下：

  关键字	参数说明
  query	待执行的sql语句
  vars_list	变量列表，匹配query中?为占位符

  返回值说明如下：

  关键字	参数说明
  result	查询结果，[]map[string][]byte 的形式
  err	报错信息

  调用示例见附录2。

• engine.Insert()

  插入数据使用Insert方法，可以插入单条数据，也可以批量插入多条数据。

  参数：一个或多个Struct的指针，一个或多个Struct的Slice的指针。

  返回值说明如下：

  关键字	参数说明
  affected	插入的记录数
  err	报错信息

  调用示例见附录2。

• engine.Update()

  更新数据。

  参数：结构体指针或Map[string]interface{}类型。

  返回值说明如下：

  关键字	参数说明
  affected	更新的记录数
  err	报错信息

  调用示例见附录2。

• engine.Delete()

  删除数据。

  参数：struct的指针。

  返回值说明如下：

  关键字	参数说明
  affected	删除的记录数
  err	报错信息

  调用示例见附录2。

• engine.Get()

  此方法用于查询单条数据，并使用返回的字段为传入的对象赋值。

  参数：结构体。

  返回值说明如下：

  关键字	参数说明
  has	该条记录是否存在
  err	报错信息

  调用示例见附录2。

• engine.Find()

  此方法用于返回所有符合条件的记录。

  参数：对象切片的指针或 map 的指针。

  返回值：如果有错误则返回报错信息

  调用示例见附录2。