WCDB

 WCDB is a cross-platform database framework developed by WeChat.

中文版本请参看这里

WCDB is an efficient, complete, easy-to-use mobile database framework used in the WeChat application. It's currently available on iOS, macOS and Android.

WCDB for iOS/macOS

Features

• Easy-to-use. Through WCDB, you can get objects from database in one line code.

  • WINQ (WCDB language integrated query): WINQ is a native data querying capability which frees developers from writing glue code to concatenate SQL query strings.

  • ORM (Object Relational Mapping): WCDB provides a flexible, easy-to-use ORM for creating tables, indices and constraints, as well as CRUD through ObjC objects.

    [database getObjectsOfClass:WCTSampleConvenient.class
                      fromTable:tableName
                          where:WCTSampleConvenient.intValue>=10
                          limit:20];

• Efficient. Through the framework layer and sqlcipher source optimization, WCDB have more efficient performance.

  • Multi-threaded concurrency: WCDB supports concurrent read-read and read-write access via connection pooling.
  • Batch Write Performance Test.  For more benchmark data, please refer to our benchmark.

• Complete.

  • Encryption Support: WCDB supports database encryption via SQLCipher.
  • Corruption recovery: WCDB provides a built-in repair kit for database corruption recovery.
  • Anti-injection: WCDB provides a built-in protection from SQL injection.

Getting Started

Prerequisites

• Apps using WCDB can target: iOS 7 or later, macOS 10.9 or later.
• Xcode 8.0 or later required.
• Objective-C++ required.

Installation

• Via Cocoapods:
  1. Install CocoaPods.
  2. Run pod repo update to make CocoaPods aware of the latest available WCDB versions.
  3. In your Podfile, add pod 'WCDB' to your app target.
  4. From the command line, run pod install.
  5. Use the .xcworkspace file generated by CocoaPods to work on your project.
  6. Add #import <WCDB/WCDB.h> at the top of your Objective-C++ source files and start your WCDB journey.
  7. Since WCDB is an Objective-C++ framework, for those files in your project that includes WCDB, you should rename their extension .m to .mm.
• Via Carthage:
  1. Install Carthage.
  2. Add github "Tencent/WCDB" to your Cartfile.
  3. Run carthage update.
  4. Drag WCDB.framework from the appropriate platform directory in Carthage/Build/ to the Linked Binary and Libraries section of your Xcode project’s Build Phases settings.
  5. On your application targets' Build Phases settings tab, click the "+" icon and choose New Run Script Phase. Create a Run Script with carthage copy-frameworks and add the paths to the frameworks under Input Files: $(SRCROOT)/Carthage/Build/iOS/WCDB.framework or $(SRCROOT)/Carthage/Build/Mac/WCDB.framework.
  6. Add #import <WCDB/WCDB.h> at the top of your Objective-C++ source files and start your WCDB journey.
  7. Since WCDB is an Objective-C++ framework, for those files in your project that includes WCDB, you should rename their extension .m to .mm.
• Via Dynamic Framework: Note that Dynamic frameworks are not compatible with iOS 7. See “Static Framework” for iOS 7 support.
  1. Getting source code from git repository and update the submodule of sqlcipher.
     • git clone https://github.com/Tencent/wcdb.git
     • cd wcdb
     • git submodule update --init sqlcipher
  2. Drag WCDB.xcodeproj in wcdb/apple/ into your project.
  3. Add WCDB.framework to the Enbedded Binaries section of your Xcode project's General settings. Note that there are two frameworks here and the dynamic one should be chosen. You can check it at Build Phases->Target Dependencies. The right one is WCDB while `WCDB iOS Static is used for static lib.
  4. Add #import <WCDB/WCDB.h> at the top of your Objective-C++ source files and start your WCDB journey.
  5. Since WCDB is an Objective-C++ framework, for those files in your project that includes WCDB, you should rename their extension .m to .mm.
• Via Static Framework:
  1. Getting source code from git repository and update the submodule of sqlcipher.
     • git clone https://github.com/Tencent/wcdb.git
     • cd wcdb
     • git submodule update --init sqlcipher
  2. Drag WCDB.xcodeproj in wcdb/apple/ into your project.
  3. Add WCDB iOS Static to the Target Dependencies section of your Xcode project's Build Phases settings.
  4. Add WCDB.framework， libz.tbd to the Linked Binary and Libraries section of your Xcode project's Build Phases settings. Note that there are two WCDB.framework, you should choose the one from WCDB iOS Static target.
  5. Add -all_load and -ObjC to the Other Linker Flags section of your Xcode project's Build Settings.
  6. Add #import <WCDB/WCDB.h> at the top of your Objective-C++ source files and start your WCDB journey.
  7. Since WCDB is an Objective-C++ framework, for those files in your project that includes WCDB, you should rename their extension .m to .mm.

Tutorials

Tutorials can be found here.

Documentations

• Documentations can be found on our Wiki.
• API references for iOS/macOS can be found here.
• Performance data can be found on our benchmark.

from https://github.com/Tencent/wcdb