turtleDB 使用教程

turtleDB 使用教程

turtleDBOfficial turtleDB project项目地址:https://gitcode.com/gh_mirrors/tu/turtleDB

项目介绍

turtleDB 是一个轻量级的嵌入式数据库，旨在为前端和移动应用提供简单、高效的数据存储解决方案。它支持多种数据结构，如键值对、文档等，并且可以无缝集成到各种 JavaScript 环境中。

项目快速启动

安装

首先，通过 npm 安装 turtleDB：

npm install turtle-db

初始化数据库

在你的项目中引入 turtleDB 并初始化数据库：

const turtleDB = require('turtle-db');

const db = new turtleDB({
  name: 'myDatabase',
  path: './data'
});

db.open().then(() => {
  console.log('Database opened successfully');
}).catch((err) => {
  console.error('Failed to open database', err);
});

插入数据

使用 insert 方法插入数据：

db.insert({ name: 'Alice', age: 25 }).then((doc) => {
  console.log('Document inserted', doc);
}).catch((err) => {
  console.error('Failed to insert document', err);
});

查询数据

使用 find 方法查询数据：

db.find({ name: 'Alice' }).then((docs) => {
  console.log('Found documents', docs);
}).catch((err) => {
  console.error('Failed to find documents', err);
});

应用案例和最佳实践

案例一：前端应用数据存储

在前端应用中，turtleDB 可以作为本地存储解决方案，用于存储用户数据、配置信息等。例如，在一个简单的待办事项应用中，可以使用 turtleDB 存储用户的任务列表。

const db = new turtleDB({
  name: 'todoApp',
  path: './data'
});

db.open().then(() => {
  // 插入任务
  db.insert({ task: 'Buy groceries', completed: false });
  // 查询任务
  db.find({ completed: false }).then((tasks) => {
    console.log('Pending tasks', tasks);
  });
});

案例二：移动应用数据同步

在移动应用中，turtleDB 可以与后端数据库同步，实现离线数据访问和在线数据同步。例如，在一个笔记应用中，可以使用 turtleDB 存储本地笔记，并在网络可用时同步到服务器。

const db = new turtleDB({
  name: 'notesApp',
  path: './data'
});

db.open().then(() => {
  // 插入笔记
  db.insert({ title: 'Meeting Notes', content: 'Discuss project progress' });
  // 查询笔记
  db.find({}).then((notes) => {
    console.log('All notes', notes);
  });
});

典型生态项目

项目一：turtleDB-sync

turtleDB-sync 是一个用于 turtleDB 的数据同步库，支持与后端数据库（如 MongoDB）的双向同步。它可以帮助开发者实现离线数据访问和在线数据同步的功能。

项目二：turtleDB-react

turtleDB-react 是一个用于 React 应用的 turtleDB 封装库，提供了 React 组件和 Hooks，方便在 React 应用中使用 turtleDB。

import { useTurtleDB } from 'turtle-db-react';

function TodoList() {
  const { db } = useTurtleDB();

  useEffect(() => {
    db.open().then(() => {
      db.find({ completed: false }).then((tasks) => {
        console.log('Pending tasks', tasks);
      });
    });
  }, [db]);

  return (
    <div>
      <h1>Todo List</h1>
      {/* 渲染任务列表 */}
    </div>
  );
}

通过这些生态项目，开发者可以更方便地在不同的应用场景中使用 turtleDB，实现高效的数据存储和同步。

turtleDBOfficial turtleDB project项目地址:https://gitcode.com/gh_mirrors/tu/turtleDB