Build and Run


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

      Steps in Getting Started

      Install | Build

      Verify Install

      Now you have Couchbase Lite for C installed, you can verify that your apps build correctly.

      Enter the C code from Example 1 into your editor of choice and build it.

      Running it will create a database, add a document, retrieve the document, update the document and then delete the document.

      Example 1. Sample code
      //  Purpose-- provide an overview of available crud  and sync functionality
      // Get the database (and create it if it doesn't exist)
      CBLError err;
      CBLDatabase* database = CBLDatabase_Open(FLSTR("mydb"), NULL, &err);
      if(!database) {
          // Error handling.  For brevity, this is truncated in the rest of the snippet
          // and omitted in other doc code snippets
          fprintf(stderr, "Error opening database (%d / %d)\n", err.domain, err.code);
          FLSliceResult msg = CBLError_Message(&err);
          fprintf(stderr, "%.*s\n", (int)msg.size, (const char *)msg.buf);
      // The lack of 'const' indicates this document is mutable
      // Create a new document (i.e. a record) in the database
      CBLDocument* mutableDoc = CBLDocument_Create();
      FLMutableDict properties = CBLDocument_MutableProperties(mutableDoc);
      FLMutableDict_SetFloat(properties, FLSTR("version"), 3.0f);
      // Save it to the database
      if(!CBLDatabase_SaveDocument(database, mutableDoc, &err)) {
          // Failed to save, do error handling as above
      // Since we will release the document, make a copy of the ID since it
      // is an internal pointer.  Whenever we create or get an FLSliceResult
      // or FLStringResult we will need to free it later too!
      FLStringResult id = FLSlice_Copy(CBLDocument_ID(mutableDoc));
      // Update a document
      mutableDoc = CBLDatabase_GetMutableDocument(database, FLSliceResult_AsSlice(id), &err);
      if(!mutableDoc) {
          // Failed to retrieve, do error handling as above.  NOTE: error code 0 simply means
          // the document does not exist.
      properties = CBLDocument_MutableProperties(mutableDoc);
      FLMutableDict_SetString(properties, FLSTR("language"), FLSTR("C"));
      if(!CBLDatabase_SaveDocument(database, mutableDoc, &err)) {
          // Failed to save, do error handling as above
      // Note const here, means readonly
      const CBLDocument* docAgain = CBLDatabase_GetDocument(database, FLSliceResult_AsSlice(id), &err);
      if(!docAgain) {
          // Failed to retrieve, do error handling as above.  NOTE: error code 0 simply means
          // the document does not exist.
      // No copy this time, so no release later (notice it is not FLStringResult this time)
      FLString retrievedID = CBLDocument_ID(docAgain);
      FLDict retrievedProperties = CBLDocument_Properties(docAgain);
      FLString retrievedLanguage = FLValue_AsString(FLDict_Get(retrievedProperties, FLSTR("language")));
      printf("Document ID :: %.*s\n", (int)retrievedID.size, (const char *)retrievedID.buf);
      printf("Learning %.*s\n", (int)retrievedLanguage.size, (const char *)retrievedLanguage.buf);
      // Create a query to fetch documents of type SDK
      int errorPos;
      CBLQuery* query = CBLDatabase_CreateQuery(database, kCBLN1QLLanguage, FLSTR("SELECT * FROM _ WHERE type = \"SDK\""), &errorPos, &err);
      if(!query) {
          // Failed to create query, do error handling as above
          // Note that errorPos will contain the position in the N1QL string
          // that the parse failed, if applicable
      CBLResultSet* result = CBLQuery_Execute(query, &err);
      if(!result) {
          // Failed to run query, do error handling as above
      // TODO: Result set count?
      // Create replicator to push and pull changes to and from the cloud
      CBLEndpoint* targetEndpoint = CBLEndpoint_CreateWithURL(FLSTR("ws://localhost:4984/getting-started-db"), &err);
      if(!targetEndpoint) {
          // Failed to create endpoint, do error handling as above
      CBLReplicatorConfiguration replConfig;
      CBLAuthenticator* basicAuth = CBLAuth_CreatePassword(FLSTR("john"), FLSTR("pass"));
      memset(&replConfig, 0, sizeof(replConfig));
      replConfig.database = database;
      replConfig.endpoint = targetEndpoint;
      replConfig.authenticator = basicAuth;
      CBLReplicator* replicator = CBLReplicator_Create(&replConfig, &err);
      if(!replicator) {
          // Failed to create replicator, do error handling as above
      // Assume a function like the simple following
      // static void getting_started_change_listener(void* context, CBLReplicator* repl, const CBLReplicatorStatus* status) {
      //     if(status->error.code != 0) {
      //         printf("Error %d / %d\n", status->error.domain, status->error.code);
      //     }
      // }
      CBLListenerToken* token = CBLReplicator_AddChangeListener(replicator, getting_started_change_listener, NULL);
      CBLReplicator_Start(replicator, false);
      // Later, stop and release the replicator