harmony 鸿蒙关系型数据库开发指导

  • 2022-08-09
  • 浏览 (1116)

关系型数据库开发指导

场景介绍

关系型数据库是在SQLite基础上实现的本地数据操作机制,提供给用户无需编写原生SQL语句就能进行数据增删改查的方法,同时也支持原生SQL语句操作。

接口说明

数据库的创建和删除

关系型数据库提供了数据库创建方式,以及对应的删除接口,涉及的API如下所示。

表1 数据库创建和删除API

类名 接口名 描述
RdbStoreConfig RdbStoreConfig(const std::string &path,
StorageMode storageMode = StorageMode::MODE_DISK,
bool readOnly = false,
const std::vector &encryptKey = std::vector(),
const std::string &journalMode = “”,
const std::string &syncMode = “”,
const std::string &databaseFileType = “”,
const std::string &databaseFileSecurityLevel = “”)
对数据库进行配置,包括设置数据库名、存储模式、日志模式、同步模式,是否为只读,及数据库加密。
  • path:数据库路径;
  • readOnly:是否只读;
  • storageMode:存储模式;
  • encryptKey:加密密钥;
  • journalMode:日志模式;
  • syncMode:同步模式;
  • databaseFileType:数据库类型;
  • databaseFileSecurityLevel:安全等级
RdbOpenCallback int OnCreate(RdbStore &rdbStore) 数据库创建时被回调,开发者可以在该方法中初始化表结构,并添加一些应用使用到的初始化数据。
RdbOpenCallback int OnUpgrade(RdbStore &rdbStore, int currentVersion, int targetVersion) 数据库升级时被回调。
RdbOpenCallback int OnDowngrade(RdbStore &rdbStore, int currentVersion, int targetVersion) 数据库降级时被回调。
RdbHelper std::shared_ptr<RdbStore> GetRdbStore(const RdbStoreConfig &config, int version, RdbOpenCallback &openCallback, int &errCode) 根据配置创建或打开数据库。
RdbHelper int DeleteRdbStore(const std::string &path) 删除指定的数据库。

数据库谓词的使用

关系型数据库提供了用于设置数据库操作条件的谓词AbsRdbPredicates,其中包括两个实现子类RdbPredicates和RawRdbPredicates:

  • RdbPredicates:开发者无需编写复杂的SQL语句,仅通过调用该类中条件相关的方法,如equalTo、notEqualTo、groupBy、orderByAsc、beginsWith等,就可自动完成SQL语句拼接,方便用户聚焦业务操作。
  • RawRdbPredicates:可满足复杂SQL语句的场景,支持开发者自己设置where条件子句和whereArgs参数。不支持equalTo等条件接口的使用。

表2 数据库谓词API |类名|接口名|描述| | —-| —-| —-| |RdbPredicates|AbsPredicates *EqualTo(std::string field, std::string value)|设置谓词条件,满足field字段与value值相等。| |RdbPredicates|AbsPredicates *NotEqualTo(std::string field, std::string value)|设置谓词条件,满足field字段与value值不相等。| |RdbPredicates|AbsPredicates *BeginsWith(std::string field, std::string value)|设置谓词条件,满足field字段以value值开头。| |RdbPredicates|AbsPredicates *Between(std::string field, std::string low, std::string high)|设置谓词条件,满足field字段在最小值low和最大值high之间。| |RdbPredicates|AbsPredicates *OrderByAsc(std::string field)|设置谓词条件,根据field字段升序排列。| |RdbPredicates|void SetWhereClause(std::string whereClause)|设置where条件子句。| |RdbPredicates|void SetWhereArgs(std::vector<std::string> whereArgs)|设置whereArgs参数,该值表示where子句中占位符的值。| |RdbPredicates|AbsRdbPredicates *InDevices(std::vectorstd::string& devices)|设置谓词条件,同步分布式数据库时指定组网内的远程设备。| |RdbPredicates|AbsRdbPredicates *InAllDevices()|设置谓词条件,同步分布式数据库时连接到组网内的所有远程设备。|

数据表的增删改查

关系型数据库提供对本地数据增删改查操作的能力,相关API如下所示。

  • 新增

关系型数据库提供了插入数据的接口,通过ValuesBucket输入要存储的数据,通过返回值判断是否插入成功,插入成功时返回最新插入数据所在的行号,失败时则返回-1。

表3 数据表插入API

类名 接口名 描述
RdbStore int Insert(int64_t &outRowId, const std::string &table, const ValuesBucket &initialValues) 向数据库插入数据。
  • table:待添加数据的表名。
  • initialValues:以ValuesBucket存储的待插入的数据。它提供一系列put方法,如PutString(const std::string &columnName, const std::string &value),PutDouble(const std::string &columnName, double value),用于向ValuesBucket中添加数据。
  • 删除

调用删除接口,通过AbsRdbPredicates指定删除条件。该接口的返回值表示删除的数据行数,可根据此值判断是否删除成功。如果删除失败,则返回0。

表4 数据表删除API |类名|接口名|描述| | —-| —-| —-| |RdbStore|int Delete(int &deletedRows, const AbsRdbPredicates &predicates)|删除数据。

  • deletedRows:删除的记录条数。
  • predicates:Rdb谓词,指定了删除操作的表名和条件。AbsRdbPredicates的实现类有两个:RdbPredicates和RawRdbPredicates。
    • RdbPredicates:支持调用谓词提供的equalTo等接口,设置删除条件。
    • RawRdbPredicates:仅支持设置表名、where条件子句、whereArgs三个参数,不支持equalTo等接口调用。
|

  • 更新

调用更新接口,传入要更新的数据,并通过AbsRdbPredicates指定更新条件。该接口的返回值表示更新操作影响的行数。如果更新失败,则返回0。

表5 数据表更新API |类名|接口名|描述| | —-| —-| —-| |RdbStore|int Update(int &changedRows, const ValuesBucket &values, const AbsRdbPredicates &predicates)|更新数据库表中符合谓词指定条件的数据。

  • changedRows:更新的记录条数。
  • values:以ValuesBucket存储的要更新的数据。
  • predicates:指定了更新操作的表名和条件。AbsRdbPredicates的实现类有两个:RdbPredicates和RawRdbPredicates。
    • RdbPredicates:支持调用谓词提供的equalTo等接口,设置更新条件。
    • RawRdbPredicates:仅支持设置表名、where条件子句、whereArgs三个参数,不支持equalTo等接口调用。
|

  • 查询

关系型数据库提供了两种查询数据的方式:

  • 直接调用查询接口。使用该接口,会将包含查询条件的谓词自动拼接成完整的SQL语句进行查询操作,无需用户传入原生的SQL语句。
  • 执行原生的SQL语句进行查询操作。

表6 数据表查询API |类名|接口名|描述| | —-| —-| —-| |RdbStore|std::unique_ptr Query(const AbsRdbPredicates &predicates, const std::vector<std::string> columns)|查询数据。

  • predicates:谓词,可以设置查询条件。AbsRdbPredicates的实现类有两个:RdbPredicates和RawRdbPredicates。
    • RdbPredicates:支持调用谓词提供的equalTo等接口,设置查询条件。
    • RawRdbPredicates:仅支持设置表名、where条件子句、whereArgs三个参数,不支持equalTo等接口调用。
  • columns:规定查询返回的列。
| |RdbStore|std::unique_ptr QuerySql(const std::string &sql, const std::vector<std::string> &selectionArgs = std::vector<std::string>())|执行原生的用于查询操作的SQL语句。
  • sql:原生用于查询的sql语句。
  • selectionArgs:sql语句中占位符参数的值,若select语句中没有使用占位符,该参数可以设置为null。
|

查询结果集的使用

关系型数据库提供了查询返回的结果集ResultSet,其指向查询结果中的一行数据,供用户对查询结果进行遍历和访问。ResultSet对外API如下所示。

表7 结果集API |类名|接口名|描述| | —-| —-| —-| |ResultSet|int GoTo(int offset)|从结果集当前位置移动指定偏移量。| |ResultSet|int GoToRow(int position)|将结果集移动到指定位置。| |ResultSet|int GoToNextRow()|将结果集向后移动一行。| |ResultSet|int GoToPreviousRow()|将结果集向前移动一行。| |ResultSet|int IsStarted(bool &result)|判断结果集是否被移动过。| |ResultSet|int IsEnded(bool &result)|判断结果集是否被移动到最后一行之后。| |ResultSet|int IsAtFirstRow(bool &result)|判断结果集当前位置是否在第一行。| |ResultSet|int IsAtLastRow(bool &result)|判断结果集当前位置是否在最后一行。| |ResultSet|int GetRowCount(int &count)|获取当前结果集中的记录条数。| |ResultSet|int GetColumnCount(int &count)|获取结果集中的列数。| |ResultSet|int GetString(int columnIndex, std::string &value)|获取当前行指定列的值,以String类型返回。| |ResultSet|int GetBlob(int columnIndex, std::vector<uint8_t> &blob)|获取当前行指定列的值,以字节数组形式返回。| |ResultSet|int GetDouble(int columnIndex, double &value)|获取当前行指定列的值,以double型返回。|

设置分布式列表

用户可以对当前数据库中的列表设置为分布式列表。

表8 设置分布式列表 |类名|接口名|描述| | —-| —-| —-| |RdbStore|bool SetDistributedTables(const std::vectorstd::string& tables)|设置分布式列表。

  • tables:要设置的分布式列表表名

根据本地表名获取指定远程设备的分布式表名

用户根据本地表名获取指定远程设备的分布式表名。在查询远程设备数据库时,需要使用分布式表名。

表9 根据本地表名获取指定远程设备的分布式表名 |类名|接口名|描述| | —-| —-| —-| |RdbStore|std::string ObtainDistributedTableName(const std::string& device, const std::string& table)|根据本地表名获取指定远程设备的分布式表名。在查询远程设备数据库时,需要使用分布式表名。

  • device:远程设备ID
  • table:本地表名

在设备之间同步数据

表10 在设备之间同步数据 |类名|接口名|描述| | —-| —-| —-| |RdbStore|bool Sync(const SyncOption& option, const AbsRdbPredicates& predicate, const SyncCallback& callback)|在设备之间同步数据。

  • option:同步选项;mode:同步模式(PUSH表示数据从本地设备推送到远程设备/PULL表示数据从远程设备拉至本地设备);isBlock:是否阻塞
  • callback:指定的callback回调函数

注册数据库的观察者

表11 注册数据库的观察者 |类名|接口名|描述| | —-| —-| —-| |RdbStore|bool Subscribe(const SubscribeOption& option, RdbStoreObserver *observer)|注册数据库的观察者。当分布式数据库中的数据发生更改时,将调用回调。

  • option:订阅类型;
  • observer:指分布式数据库中数据更改事件的观察者

从数据库中删除指定类型的指定观察者

表12 从数据库中删除指定类型的指定观察者 |类名|接口名|描述| | —-| —-| —-| |RdbStore|bool UnSubscribe(const SubscribeOption& option, RdbStoreObserver *observer)|从数据库中删除指定类型的指定观察者。

  • option:订阅类型;
  • observer:指已注册的数据更改观察者

数据库的备份和恢复

关系型数据库提供对本地数据库文件的备份和恢复能力,相关API如下所示。

  • 备份

关系型数据库提供了备份数据库文件的接口,通过databasePath指定的备份文件名(支持路径)备份当前数据库文件。通过返回值判断是否备份成功,成功时返回0,失败时则返回相应的错误码。

表13 数据库备份API

类名 接口名 描述
RdbStore int Backup(const std::string databasePath, const std::vector&lt;uint8_t&gt; destEncryptKey) 备份数据库文件。
  • databasePath:指定的备份文件名。
  • destEncryptKey:数据库的加密密钥。注意:当前只支持非加密数据库的备份。
  • 恢复

关系型数据库提供了恢复数据库文件的接口,通过backupPath指定的备份文件名(支持路径)恢复当前数据库文件。通过返回值判断是否恢复成功,成功时返回0,失败时则返回相应的错误码。

表14 数据库恢复API

类名 接口名 描述
RdbStore int Restore(const std::string backupPath, const std::vector&lt;uint8_t&gt; &newKey) 恢复数据库文件。
  • backupPath:指定的备份文件名。
  • newKey:数据库的加密密钥。注意:当前只支持非加密数据库的恢复。

事务

事务(Transaction)是一个对数据库执行工作单元。通过返回值判断事务是否成功,成功时返回0,失败时则返回相应的错误码。

表15 事务API

类名 接口名 描述
RdbStore int BeginTransaction() 开启一个事务。
RdbStore int Commit() 保存更改。
RdbStore int RollBack() 回滚所做的更改。

约束与限制

无。

开发步骤

  1. 创建数据库。

    a. 配置数据库相关信息,包括数据库的名称、存储模式、是否为只读模式等。

    b. 初始化数据库表结构和相关数据。

    c. 创建数据库。

    示例代码如下:

    const std::string DATABASE_NAME = RDB_TEST_PATH + "RdbStoreTest.db";
    const std::string CREATE_TABLE_TEST = "CREATE TABLE IF NOT EXISTS test (id INTEGER PRIMARY KEY AUTOINCREMENT, name TEXT, age INTEGER, salary REAL, blobType BLOB)";
    
    
    class OpenCallback : public RdbOpenCallback {
    public:
        int OnCreate(RdbStore &rdbStore) override;
        int OnUpgrade(RdbStore &rdbStore, int oldVersion, int newVersion) override;
    };
    
    
    int OpenCallback::OnCreate(RdbStore &store)
    {
        return store.ExecuteSql(CREATE_TABLE_TEST);
    }
    
    
    RdbStoreConfig config(DATABASE_NAME);
    OpenCallback callback;
    
    
    std::shared_ptr<RdbStore> store = RdbHelper::GetRdbStore(config, 1, callback, 0); 
    
  2. 插入数据。

    a. 构造要插入的数据,以ValuesBucket形式存储。

    b. 调用关系型数据库提供的插入接口。

    c. 创建数据库。

    示例代码如下:

    ValuesBucket values;
    
    
    values.PutInt("id", 1);
    values.PutString("name", std::string("Tom"));
    values.PutInt("age", 18);
    values.PutDouble("salary", 100.5);
    values.PutBlob("blobType", std::vector<uint8_t>{ 1, 2, 3 });
    store->Insert(id, "test", values);
    
  3. 查询数据。

    a. 构造用于查询的谓词对象,设置查询条件。

    b. 指定查询返回的数据列。

    c. 调用查询接口查询数据。

    d. 调用结果集接口,遍历返回结果。

    示例代码如下:

    std::vector<std::string> columns = {"id", "name", "age", "salary"};
    
    
    RdbPredicates predicates("test");
    predicates.EqualTo("age", "25")->OrderByAsc("salary");
    std::unique_ptr<ResultSet> resultSet  = store->Query(predicates, columns)
    resultSet.goToNextRow();
    
  4. 设置分布式同步表

    a. 调用接口设置分布式同步表。

    示例代码如下:

    store->SetDistributedTables("test");
    
  5. 分布式数据同步

    a. 定义同步模式和阻塞状态。

    b. 构造用于同步分布式表的谓词对象,指定组网内的远程设备。

    c. 调用接口同步数据。

    示例代码如下:

    SyncOption option;
    option.mode = PUSH;
    option.isBlock = true;
    AbsRdbPredicates predicate("test");
    predicate.InAllDevices();
    store->Sync(option, predicate, [](const SyncResult& result) {
        for (const auto& [device, status] : result) {
            LogI("device=%s status=%d", device.c_str(), status);
        }
    });
    
  6. 分布式数据订阅

    a. 重写数据更改观察者OnChange()函数。

    b. 定义分布式数据订阅类型。

    c. 调用接口实现分布式数据订阅,或取消订阅。

    示例代码如下:

    class MyObserver : public RdbStoreObserver {
    public:
        void OnChange(const std::vector<std::string>& devices) override {
            for (const auto& device : devices) {
                LOGI("device=%s data change", device.c_str());
            }
        }
    };
    
    
    SubscribeOption option;
    option.mode = SubscribeMode::REMOTE;
    MyObserver observer;
    store->Subscribe(option, &observer);  // 分布式数据订阅
    
    
    store->UnSubscribe(option, &observer);  // 取消订阅
    
  7. 跨设备查询

a. 根据本地表名获取指定远程设备的分布式表名。

b. 根据指定SQL语句查询数据库中的数据。

示例代码如下: c++ std::string tableName = store->ObtainDistributedTableName("123456789abcd", "test"); auto resultSet = store->QuerySql("SELECT * from ?;", tableName);

  1. 数据库的备份和恢复

a. 根据指定的数据库备份文件名备份当前数据库。

b. 根据指定的数据库备份文件恢复当前数据库。

示例代码如下: c++ std::string backupName = "backup.db"; // 指定数据库的备份文件名 std::vector<uint8_t> key; // 数据库的加密密钥 int errno = store->Backup(backupName, key); errno = store->Restore(backupName, key);

你可能感兴趣的鸿蒙文章

harmony 鸿蒙subsystems

harmony 鸿蒙AI框架开发指导

harmony 鸿蒙应用特权配置指南

harmony 鸿蒙开发实例

harmony 鸿蒙搭建环境

harmony 鸿蒙开发指导

harmony 鸿蒙概述

harmony 鸿蒙ArkCompiler开发指导

harmony 鸿蒙appspawn应用孵化组件

harmony 鸿蒙bootstrap服务启动组件

0  赞