A newer version of this documentation is available.

View Latest

Build and Run


      Description — Build and run a starter app to validate your install of Couchbase Lite on Objective-C

      Quick Steps

      1. Within XCode, create a new Objective-C app project

      2. Within the ViewController.m file, replace the boilerplate codein with that shown in Example 1. Note you can also get this from github.

      3. Build and Run the code.
        You should see the document ID and property printed to the console, indicating that the document was successfully persisted to the database as shown in Figure 1

      getting started ios
      Figure 1. Console log output
      Example 1. Get Started code example

      This snippet demonstrates how to run basic CRUD operations, a simple Query and running bi-directional replications with Sync Gateway.

      //  GettingStarted.m
      //  threeBeta01prod
      //  Created by Ian Bridge on 04/10/2021.
      #import "GettingStarted.h"
      #import <CouchbaseLite/CouchbaseLite.h>
      @implementation GettingStarted
      - (void)viewDidLoad {
          [super viewDidLoad];
          // Do any additional setup after loading the view.
          // Get the database (and create it if it doesn’t exist).
          bool *testReplication;
          testReplication = false;
          NSError *error;
          CBLDatabase *database = [[CBLDatabase alloc] initWithName:@"mydb" error:&error];
          // Create a new document (i.e. a record) in the database.
          CBLMutableDocument *mutableDoc = [[CBLMutableDocument alloc] init];
          [mutableDoc setFloat:2.0 forKey:@"version"];
          [mutableDoc setString:@"SDK" forKey:@"type"];
          // Save it to the database.
          [database saveDocument:mutableDoc error:&error];
          // Update a document.
          CBLMutableDocument *mutableDoc2 = [[database documentWithID:mutableDoc.id] toMutable];
          [mutableDoc2 setString:@"Objective-C" forKey:@"language"];
          [database saveDocument:mutableDoc2 error:&error];
          CBLDocument *document = [database documentWithID:mutableDoc2.id];
          // Log the document ID (generated by the database)
          // and properties
          NSLog(@"Document ID :: %@", document.id);
          NSLog(@"Learning %@", [document stringForKey:@"language"]);
          // Create a query to fetch documents of type SDK.
          CBLQueryExpression *type = [[CBLQueryExpression property:@"type"] equalTo:[CBLQueryExpression string:@"SDK"]];
          CBLQuery *query = [CBLQueryBuilder select:@[[CBLQuerySelectResult all]]
                                                from:[CBLQueryDataSource database:database]
          // Run the query
          CBLQueryResultSet *result = [query execute:&error];
          NSLog(@"Number of rows :: %lu", (unsigned long)[[result allResults] count]);
          if (testReplication) {
              // Create replicators to push and pull changes to and from the cloud.
              NSURL *url = [[NSURL alloc] initWithString:@"ws://localhost:4984/getting-started-db"];
              CBLURLEndpoint *targetEndpoint = [[CBLURLEndpoint alloc] initWithURL:url];
              CBLReplicatorConfiguration *replConfig = [[CBLReplicatorConfiguration alloc] initWithDatabase:database target:targetEndpoint];
              replConfig.replicatorType = kCBLReplicatorTypePushAndPull;
              // Add authentication.
              replConfig.authenticator = [[CBLBasicAuthenticator alloc] initWithUsername:@"john" password:@"pass"];
              // Create replicator (make sure to add an instance or static variable named _replicator)
              CBLReplicator *_replicator = [CBLReplicator alloc];
              _replicator = [[CBLReplicator alloc] initWithConfig:replConfig];
              // Listen to replicator change events.
              [_replicator addChangeListener:^(CBLReplicatorChange *change) {
                  if (change.status.error) {
                      NSLog(@"Error code: %ld", change.status.error.code);
              // Start replication
              [_replicator start];

      Before synchronizing documents to Sync Gateway you will need to disable App Transport Security. In the Xcode navigator, right-click on Info.plist and open it as a source file.

      info plist

      Append the following inside of the <dict> XML tags to disable ATS.