Drizzle <> Expo SQLite

根据**官方网站**的介绍，Expo 是一个用于在 React Native 上开发、构建和发布应用程序的工具生态系统。它由 Hermes JavaScript 运行时和 Metro 打包器提供支持，Drizzle Expo 驱动程序旨在原生支持这两种技术。

Drizzle ORM 拥有适用于 Expo SQLite 的一流工具包

Expo SQLite 的原生 ORM 驱动程序 ✅
Drizzle Kit 支持应用程序中的迁移生成和打包 ✅
Drizzle Studio 开发工具插件，用于浏览设备上的数据库 ✅
实时查询 ✅

npm

yarn

pnpm

bun

npm i drizzle-orm expo-sqlite@next
npm i -D drizzle-kit

yarn add drizzle-orm expo-sqlite@next
yarn add -D drizzle-kit

pnpm add drizzle-orm expo-sqlite@next
pnpm add -D drizzle-kit

bun add drizzle-orm expo-sqlite@next
bun add -D drizzle-kit

import { drizzle } from "drizzle-orm/expo-sqlite";
import { openDatabaseSync } from "expo-sqlite";

const expo = openDatabaseSync("db.db");
const db = drizzle(expo);

await db.select().from(users);

实时查询

通过 useLiveQuery hook，您可以使任何 Drizzle 查询变为响应式

import { useLiveQuery, drizzle } from 'drizzle-orm/expo-sqlite';
import { openDatabaseSync } from 'expo-sqlite';
import { Text } from 'react-native';
import * as schema from './schema';

const expo = openDatabaseSync('db.db', { enableChangeListener: true }); // <-- enable change listeners
const db = drizzle(expo);

const App = () => {
  // Re-renders automatically when data changes
  const { data } = useLiveQuery(db.select().from(schema.users));
  return <Text>{JSON.stringify(data)}</Text>;
};

export default App;

使用 Drizzle Kit 进行 Expo SQLite 迁移

您可以使用 Drizzle Kit 生成 SQL 迁移。
请务必在继续之前查看 Drizzle 迁移的工作方式。
Expo / React Native 要求将 SQL 迁移打包到应用程序中，我们已经为您考虑到了这一点。

安装 babel 插件

有必要将 SQL 迁移文件作为字符串直接打包到您的 bundle 中。

npm install babel-plugin-inline-import

更新配置文件。

您需要更新 babel.config.js、metro.config.js 和 drizzle.config.ts 文件

module.exports = function(api) {
  api.cache(true);

  return {
    presets: ['babel-preset-expo'],
    plugins: [["inline-import", { "extensions": [".sql"] }]] // <-- add this
  };
};

const { getDefaultConfig } = require('expo/metro-config');

/** @type {import('expo/metro-config').MetroConfig} */
const config = getDefaultConfig(__dirname);

config.resolver.sourceExts.push('sql'); // <--- add this

module.exports = config;

请确保在 Drizzle Kit 配置中包含 dialect: 'sqlite' 和 driver: 'expo'

import type { Config } from 'drizzle-kit';

export default {
	schema: './db/schema.ts',
	out: './drizzle',
  dialect: 'sqlite',
	driver: 'expo', // <--- very important
} satisfies Config;

生成迁移

创建 SQL 模式文件和 drizzle.config.ts 文件后，即可生成迁移

npx drizzle-kit generate

将迁移添加到您的应用程序

现在您需要将 migrations.js 文件从 ./drizzle 文件夹导入到您的 Expo/React Native 应用程序中。您可以根据需要，在应用程序启动时使用我们的自定义 useMigrations 迁移 hook 或在 useEffect hook 中手动运行迁移。

import { drizzle } from "drizzle-orm/expo-sqlite";
import { openDatabaseSync } from "expo-sqlite";
import { useMigrations } from 'drizzle-orm/expo-sqlite/migrator';
import migrations from './drizzle/migrations';

const expoDb = openDatabaseSync("db.db");

const db = drizzle(expoDb);

export default function App() {
  const { success, error } = useMigrations(db, migrations);

  if (error) {
    return (
      <View>
        <Text>Migration error: {error.message}</Text>
      </View>
    );
  }

  if (!success) {
    return (
      <View>
        <Text>Migration is in progress...</Text>
      </View>
    );
  }

  return ...your application component;
}