O
OOR
文档
OOR
文档
简介
Getting Started
安装
快速开始
Query Flow
Core Concepts
Suffix
Schema
Condition Tree
Adapters
SQLite
PostgreSQL / MySQL
Elasticsearch
Integrations
Drizzle Integration
ES Client

#安装

#基础

Bash
pnpm add oor zod

如果要用 Drizzle:

Bash
pnpm add oor drizzle-orm zod

数据库驱动仍然由你自己安装,例如:

  • PostgreSQL: pg
  • SQLite: better-sqlite3、node:sqlite、libsql 等
  • MySQL: mysql2

#导入方式

场景导入
抽象核心import { parse, makeNode, schema } from 'oor'
SQLite SQLimport { querySql, whereSql } from 'oor/sqlite'
PostgreSQL SQLimport { querySql, whereSql } from 'oor/pg'
MySQL SQLimport { querySql, whereSql } from 'oor/mysql'
Elasticsearchimport { esBody, esQuery } from 'oor/es'
Drizzle 单表封装import { withTable, withDB } from 'oor/drizzle'

#根入口

根入口只导出抽象能力:

TypeScript
import {
  SUFFIX,
  parse,
  makeNode,
  withSoft,
  page,
  sort,
  sortDir,
  schema,
  read
} from 'oor'

具体方言和插件都走子路径。

#下一步

  • 快速开始
  • Suffix 规则
  • SQL 适配器
  • 基础
  • 导入方式
  • 根入口
  • 下一步