关系型数据库(Relational Database,RDB)是一种基于关系模型来管理数据的数据库。HarmonyOS关系型数据库基于SQLite组件提供了一套完整的对本地数据库进行管理的机制,对外提供了一系列的增、删、改、查等接口,也可以直接运行用户输入的SQL语句来满足复杂的场景需要。HarmonyOS提供的关系型数据库功能更加完善,查询效率更加高效。
基于关系模型来管理数据的数据库,以行和列的形式存储数据。
数据库中用来代表数据实体的性质、特征或者数据实体之间关系的词项,主要用来定义数据库的操作条件。
指用户查询之后的结果集合,可以对数据进行访问。结果集提供了灵活的数据访问方式,可以更方便的拿到用户想要的数据。
一款轻型的数据库,是遵守ACID的关系型数据库管理系统。它是一个开源的项目。
HarmonyOS关系型数据库对外提供通用的操作接口,底层使用SQLite作为持久化存储引擎,支持SQLite具有的所有数据库特性,包括但不限于事务、索引、视图、触发器、外键、参数化查询和预编译SQL语句。
图1 关系型数据库运作机制
关系型数据库是在SQLite基础上实现的本地数据操作机制,提供给用户无需编写原生SQL语句就能进行数据增删改查的方法,同时也支持原生SQL语句操作。
数据库的创建和删除
关系型数据库提供了数据库创建方式,以及对应的删除接口,涉及的API如下所示。
类名 | 接口名 | 描述 |
---|---|---|
DatabaseHelper | DatabaseHelper(Context context) |
|
StoreConfig.Builder | public StoreConfig builder() | 对数据库进行配置,包括设置数据库名、存储模式、日志模式、同步模式,是否为只读,及数据库加密。 |
RdbOpenCallback | public abstract void onCreate(RdbStore store) | 数据库创建时被回调,开发者可以在该方法中初始化表结构,并添加一些应用使用到的初始化数据。 |
RdbOpenCallback | public abstract void onUpgrade(RdbStore store, int currentVersion, int targetVersion) | 数据库升级时被回调。 |
RdbOpenCallback | public void onDowngrade(RdbStore store, int currentVersion, int targetVersion) | 数据库降级时被回调。 |
DatabaseHelper | public RdbStore getRdbStore(StoreConfig config, int version, RdbOpenCallback openCallback, ResultSetHook resultSetHook) | 根据配置创建或打开数据库。 |
DatabaseHelper | public boolean deleteRdbStore(String name) | 删除指定的数据库。 |
数据库的加密
关系型数据库提供数据库加密的能力,在创建数据库时若指定了密钥,则会创建为加密数据库再次使用此数据库时,仍需要指定相同密钥,才能正确打开数据库。
类名 | 接口名 | 描述 |
---|---|---|
StoreConfig.Builder | public StoreConfig.Builder setEncryptKey(byte[] encryptKey) | 为数据库设置数据库加密密钥的配置类,创建或打开数据库时传入包含数据库加密密钥的配置类,即可创建或打开加密数据库。 |
数据库的增删改查
关系型数据库提供对本地数据增删改查操作的能力,相关API如下所示。
类名 | 接口名 | 描述 |
---|---|---|
RdbStore | long insert(String table, ValuesBucket initialValues) | 向数据库插入数据。
|
调用更新接口,传入要更新的数据,并通过AbsRdbPredicates指定更新条件。该接口的返回值表示更新操作影响的行数。如果更新失败,则返回0。
类名 | 接口名 | 描述 |
---|---|---|
RdbStore | int update(ValuesBucket values, AbsRdbPredicates predicates) | 更新数据库表中符合谓词指定条件的数据。
|
调用删除接口,通过AbsRdbPredicates指定删除条件。该接口的返回值表示删除的数据行数,可根据此值判断是否删除成功。如果删除失败,则返回0。
类名 | 接口名 | 描述 |
---|---|---|
RdbStore | int delete(AbsRdbPredicates predicates) | 删除数据。 predicates:Rdb谓词,指定了删除操作的表名和条件。AbsRdbPredicates的实现类有两个:RdbPredicates和RawRdbPredicates。
|
关系型数据库提供了两种查询数据的方式:
类名 | 接口名 | 描述 |
---|---|---|
RdbStore | ResultSet query(AbsRdbPredicates predicates, String[] columns) | 查询数据。
|
RdbStore | ResultSet querySql(String sql, String[] sqlArgs) | 执行原生的用于查询操作的SQL语句。 sql:原生用于查询的sql语句。 sqlArgs:sql语句中占位符参数的值,若select语句中没有使用占位符,该参数可以设置为null。 |
数据库谓词的使用
关系型数据库提供了用于设置数据库操作条件的谓词AbsRdbPredicates,其中包括两个实现子类RdbPredicates和RawRdbPredicates:
类名 | 接口名 | 描述 |
---|---|---|
RdbPredicates | RdbPredicates equalTo(String field, String value) | 设置谓词条件,满足field字段与value值相等。 |
RdbPredicates | RdbPredicates notEqualTo(String field, String value) | 设置谓词条件,满足field字段与value值不相等。 |
RdbPredicates | RdbPredicates beginsWith(String field, String value) | 设置谓词条件,满足field字段以value值开头。 |
RdbPredicates | RdbPredicates between(String field, int low, int high) | 设置谓词条件,满足field字段在最小值low和最大值high之间。 |
RdbPredicates | RdbPredicates orderByAsc(String field) | 设置谓词条件,根据field字段升序排列。 |
RawRdbPredicates | void setWhereClause(String whereClause) | 设置where条件子句。 |
RawRdbPredicates | void setWhereArgs(List<String> whereArgs) | 设置whereArgs参数,该值表示where子句中占位符的值。 |
查询结果集的使用
关系型数据库提供了查询返回的结果集ResultSet,其指向查询结果中的一行数据,供用户对查询结果进行遍历和访问。ResultSet对外API如下所示。
类名 | 接口名 | 描述 |
---|---|---|
ResultSet | boolean goTo(int offset) | 从结果集当前位置移动指定偏移量。 |
ResultSet | boolean goToRow(int position) | 将结果集移动到指定位置。 |
ResultSet | boolean goToNextRow() | 将结果集向后移动一行。 |
ResultSet | boolean goToPreviousRow() | 将结果集向前移动一行。 |
ResultSet | boolean isStarted() | 判断结果集是否被移动过。 |
ResultSet | boolean isEnded() | 判断结果集当前位置是否在最后一行之后。 |
ResultSet | boolean isAtFirstRow() | 判断结果集当前位置是否在第一行。 |
ResultSet | boolean isAtLastRow() | 判断结果集当前位置是否在最后一行。 |
ResultSet | int getRowCount() | 获取当前结果集中的记录条数。 |
ResultSet | int getColumnCount() | 获取结果集中的列数。 |
ResultSet | String getString(int columnIndex) | 获取当前行指定列的值,以String类型返回。 |
ResultSet | byte[] getBlob(int columnIndex) | 获取当前行指定列的值,以字节数组形式返回。 |
ResultSet | double getDouble(int columnIndex) | 获取当前行指定列的值,以double型返回。 |
事务
关系型数据库提供事务机制,来保证用户操作的原子性。对单条数据进行数据库操作时,无需开启事务;插入大量数据时,开启事务可以保证数据的准确性。如果中途操作出现失败,会自动执行回滚操作。
类名 | 接口名 | 描述 |
---|---|---|
RdbStore | void beginTransaction() | 开启事务。 |
RdbStore | void markAsCommit() | 设置事务的标记为成功。 |
RdbStore | void endTransaction() | 结束事务。当调用此方法前若执行markAsCommit方法,事务会提交,否则事务会自动回滚。 |
事务和结果集观察者
关系型数据库提供了事务和结果集观察者能力,当对应的事件被触发时,观察者会收到通知。
类名 | 接口名 | 描述 |
---|---|---|
RdbStore | void beginTransactionWithObserver(TransactionObserver transactionObserver) | 开启事务,并观察事务的启动、提交和回滚。 |
ResultSet | void registerObserver(DataObserver observer) | 注册结果集的观察者。 |
ResultSet | void unregisterObserver(DataObserver observer) | 注销结果集的观察者。 |
数据库的备份和恢复
用户可以将当前数据库的数据进行保存备份,还可以在需要的时候进行数据恢复。
类名 | 接口名 | 描述 |
---|---|---|
RdbStore | boolean restore(String srcName) | 数据库恢复接口,从指定的非加密数据库文件中恢复数据。 |
RdbStore | boolean restore(String srcName, byte[] srcEncryptKey, byte[] destEncryptKey) | 数据库恢复接口,从指定的数据库文件(加密和非加密均可)中恢复数据。 |
RdbStore | boolean backup(String destName) | 数据库备份接口,备份出的数据库文件是非加密的。 |
RdbStore | boolean backup(String destName, byte[] destEncryptKey) | 数据库备份接口,此方法经常用在备份出加密数据库场景。 |
创建数据库。
示例代码如下:
// 可以通过ohos.app.Context#getApplicationContext()或ohos.app.AbilityContext#getContext()获取context。
DatabaseHelper helper = new DatabaseHelper(context);
StoreConfig config = StoreConfig.newDefaultConfig("RdbStoreTest.db");
RdbOpenCallback callback = new RdbOpenCallback() {
@Override
public void onCreate(RdbStore store) {
store.executeSql("CREATE TABLE IF NOT EXISTS test (id INTEGER PRIMARY KEY AUTOINCREMENT, name TEXT NOT NULL, age INTEGER, salary REAL, blobType BLOB)");
}
@Override
public void onUpgrade(RdbStore store, int oldVersion, int newVersion) {
}
};
RdbStore store = helper.getRdbStore(config, 1, callback, null);
插入数据。
示例代码如下:
ValuesBucket values = new ValuesBucket();
values.putInteger("id", 1);
values.putString("name", "zhangsan");
values.putInteger("age", 18);
values.putDouble("salary", 100.5);
values.putByteArray("blobType", new byte[] {1, 2, 3});
long id = store.insert("test", values);
查询数据。
示例代码如下:
String[] columns = new String[] {"id", "name", "age", "salary"};
RdbPredicates rdbPredicates = new RdbPredicates("test").equalTo("age", 25).orderByAsc("salary");
ResultSet resultSet = store.query(rdbPredicates, columns);
resultSet.goToNextRow();
注册结果集观察者。
示例代码如下:
resultSet.registerObserver(dataObserverAsyncWrapper);
List<Uri> uris = new ArrayList<>();
uris.add(Uri.parse(String.format((Const.BASE_URI + Const.DATA_PATH), "")));
resultSet.setAffectedByUris(this, uris);