LitDB 项目安装与配置指南

LitDB 项目安装与配置指南

litdb Lightweight RDBMS agnostic TypeScript/JS abstraction for SQLite, PostgreSQL and MySQL 项目地址: https://gitcode.com/gh_mirrors/li/litdb

1. 项目基础介绍

LitDB 是一个轻量级的、数据库无关的 TypeScript/JavaScript 抽象层，适用于 SQLite、PostgreSQL 和 MySQL。它提供了类似于 LINQ 的类型安全 SQL 构建器，使得编写类型安全、参数化的 SQL 变得更加直观和方便。

主要编程语言：TypeScript/JavaScript

2. 关键技术和框架

• 类型安全 SQL 构建器：LitDB 的核心特性，允许开发者在编写 SQL 时获得类型安全和智能提示。
• 参数化查询：通过参数化查询来预防 SQL 注入攻击，并提高查询性能。
• 数据库无关性：抽象层使得 SQL 查询可以在不同的关系型数据库之间移植。
• ORM 集成：LitDB 可以与流行的 ORM 工具一起使用，而无需安装特定的数据库驱动。

3. 安装和配置

准备工作

在开始安装之前，请确保您的开发环境中已安装以下工具：

• Node.js（建议使用 LTS 版本）
• npm 或 yarn 包管理器

安装步骤

步骤 1：安装 Node.js

如果您尚未安装 Node.js，请从 Node.js 官方网站 下载并安装适合您操作系统的版本。

步骤 2：创建项目目录

在您的系统中创建一个新的目录用于存放项目文件，并进入该目录：

mkdir my-litdb-project
cd my-litdb-project

步骤 3：初始化项目

在项目目录中，运行以下命令来初始化一个新的 npm 项目：

npm init -y

步骤 4：安装 LitDB

使用 npm 或 yarn 安装 LitDB：

npm install litdb
# 或者
yarn add litdb

步骤 5：选择数据库驱动

根据您使用的数据库，安装相应的 LitDB 驱动：

• 对于 SQLite，可以使用 @litdb/bun-sqlite 或 @litdb/better-sqlite。
• 对于 PostgreSQL，安装 @litdb/postgres。
• 对于 MySQL，安装 @litdb/mysql。

例如，安装 PostgreSQL 驱动：

npm install @litdb/postgres
# 或者
yarn add @litdb/postgres

步骤 6：配置数据库连接

在您的项目中，创建一个新的文件（如 database.js），并配置数据库连接：

// database.js
import { createConnection } from 'typeorm';
import { PostgresConnectionOptions } from 'typeorm/driver/postgres/PostgresConnectionOptions';

const config: PostgresConnectionOptions = {
  type: 'postgres',
  host: 'localhost',
  port: 5432,
  username: 'your-username',
  password: 'your-password',
  database: 'your-database',
  // 其他配置项...
};

export const connection = createConnection(config);

确保将 'your-username'、'your-password' 和 'your-database' 替换为您的 PostgreSQL 数据库的凭据。

步骤 7：编写示例代码

在您的项目中创建一个简单的 TypeScript 文件，如 index.ts，并编写一些示例代码来测试数据库连接和查询：

// index.ts
import { connection } from './database';
import { litdb } from 'litdb';
import { Contact } from './entities/Contact';

async function main() {
  await connection;
  const db = litdb.connect(Contact);

  // 编写一些数据库操作代码...
}

main().catch((error) => console.error(error));

在 Contact.ts 文件中定义 Contact 实体：

// entities/Contact.ts
import { Entity, PrimaryGeneratedColumn, Column } from 'typeorm';

@Entity()
export class Contact {
  @PrimaryGeneratedColumn()
  id: number;

  @Column()
  name: string;

  @Column()
  email: string;
}

运行项目

完成以上步骤后，您可以使用以下命令运行项目：

npm run build
# 或者
yarn build

node dist/index.js
# 或者
npx ts-node index.ts

请根据您的项目配置调整以上命令。

以上就是 LitDB 的安装和配置指南。按照这些步骤，您应该能够成功地在您的项目中使用 LitDB。

litdb Lightweight RDBMS agnostic TypeScript/JS abstraction for SQLite, PostgreSQL and MySQL 项目地址: https://gitcode.com/gh_mirrors/li/litdb