Home

WCDB

WCDB是一个高效、完整、易用的移动数据库框架，支持iOS, macOS和Android。

WCDB for iOS/macOS

基本功能

• WINQ(WCDB语言集成查询): 通过WINQ，开发者无须为了拼接SQL的字符串而写一大坨胶水代码。
• ORM(Object Relational Mapping): WCDB支持灵活、易用的ORM。开发者可以很便捷地定义表、索引、约束，并进行增删改查操作。
• 多线程高并发: WCDB支持多线程读与读、读与写并发执行，写与写串行执行。
• 损坏修复: WCDB内建了Repair Kit用于修复损坏的数据库。
• 反注入: WCDB内建了对SQL注入的保护。
• ...

入门

基本要求

• WCDB支持iOS 8、macOS 10.10以上。
• WCDB需使用Xcode 8.0以上版本进行编译。
• 需使用Objective-C++。

安装

• 通过Carthage安装:
  1. 先安装Carthage；
  2. 在Cartfile中添加 github "Tencent/WCDB"，并执行carthage update；
  3. 将 Carthage/Build/目录下的 WCDB.framework 添加到你的项目工程配置的"Build Phases"->"Linked Binary and Libraries"中。
  4. 点击你的项目工程配置的"Build Phases"中的"+"选项，在弹出菜单中选择"New Run Script Phase"。在创建的脚本中添加 carthage copy-frameworks ，并在"Input Files"中添加$(SRCROOT)/Carthage/Build/WCDB.framework 。
• 通过源码安装:
  1. 获取源码
     • 通过git clone时，需指定recursive参数： git clone https://github.com/Tencent/wcdb.git --recursive 。
     • 若clone时未指定recursive参数，则可以通过git submodule update --init --recursive拉取submodule。
  2. 将`WCDB.xcodeproj添加到你的工程中.
  3. 在你的项目工程配置的"Build Phases"->"Target Dependencies"和"Build Phases"->"Linked Binary and Libraries"中添加WCDB.framework。
  4. 在你的项目工程配置的"General"->"Enbedded Binaries"中添加WCDB.framework。

在你的代码文件头引入头文件#import <WCDB/WCDB.h>，就可以开始使用WCDB了。

使用教程

使用教程请参考 TODO。

相关文档

• 文档： https://github.com/Tencent/wcdb/wiki
• API reference：https://tencent.github.io/wcdb/references/ios/index.html

WCDB for Android

TODO