This Swift Playground demonstrates the new Query interface in Couchbase Lite 2.0.
A step-by-step demonstration of using the playground for testing
While the Xcode playground demonstrates the queries in swift, given the unified nature of the QueryBuilder API across the various Couchbase Lite platforms, barring language specific idioms, you should be able to easily translate the queries to any of the other platform languages supported in Couchbase Lite.
So, even if you are not a Swift developer, you should be able to leverage the Xcode playground for API exploration. This video makes no assumptions about your familiarity with Swift or iOS Development so even if you are a complete newbie to iOS development, you should be able to follow along.
- iOS (Swift)
- Xcode 8.3.3 +
- Swift 3.1+
Clone the repo from GitHub by running the following command from the terminal
$ git clone https://github.com/couchbaselabs/couchbase-lite-ios-api-playground
Switch to folder containing the CartFile
$ cd /path/to/couchbase-lite-ios-api-playground/carthage
Download Couchbase Lite using Carthage . The version of Couchbase Lite used is specified in the
$ carthage update --platform ios
Create a folder named "Shared Playground Data" within your "Documents" folder on your Mac
$ mkdir ~/Documents/Shared\ Playground\ Data/
Copy the "travel-sample.cblite2" folder that is bundled with the repo into the "Shared Playground Data". This prebuilt database will be used for trying out the queries. Note that all the APIs will be exercised locally.
$ cd /path/to/couchbase-lite-ios-api-playground/ $ cp -r travel-sample.cblite2 ~/Documents/Shared\ Playground\ Data/
Copy the "joindb.cblite2" folder that is bundled with the repo into the "Shared Playground Data". This prebuilt database will be used for trying out the queries related to JOINs. Note that all the APIs will be exercised locally.
$ cd /path/to/couchbase-lite-ios-api-playground/ $ cp -r joindb.cblite2 ~/Documents/Shared\ Playground\ Data/
Exploring the Project
CBLTestBed.xcodeprojusing Xcode 8.3 or above
You should see a bunch of playground pages in your project explorer. Start with the "ToC" page.
From the "ToC" page, you can navigate to any of the other playground pages. Each playground page exercises a set of queries against the "travel-sample.cblite" database