Code examples for CBL Documents page (Scopes and Collections)

See https://osfameron.github.io/DOC-10385-mobile-scopes-collections/couchbase-lite/current/csharp/document.html for draft work done so far for C#. Same changes would need to be applied to other languages.

Changes required:

A PR to docs-couchbase-lite, to 1 single file for each Mobile SDK (except Kotlin, where there's a 2nd one, details below)

• Android
  • Java
    • https://github.com/couchbase/docs-couchbase-lite/blob/release/3.0/modules/android/examples/codesnippet_collection.java 
  • Kotlin
    • https://github.com/couchbase/docs-couchbase-lite/blob/release/3.0/modules/android/examples/codesnippet_collection.kt 
    • AND https://github.com/couchbase/docs-couchbase-lite/blob/release/3.0/modules/android/examples/snippets/app/src/main/kotlin/com/couchbase/code_snippets/FlowExamples.kt#L36-L51 
• C
  • https://github.com/couchbase/docs-couchbase-lite/blob/release/3.0/modules/c/examples/code_snippets/main.c 
• .NET
  • NB: many of changes already done but need sense check. Last few examples may need work especially.
  • https://github.com/couchbase/docs-couchbase-lite/blob/release/3.0/modules/csharp/examples/code_snippets/Program.cs 
• Java
  • https://github.com/couchbase/docs-couchbase-lite/blob/release/3.0/modules/java/examples/codesnippet_collection.java 
• ObjC
  • https://github.com/couchbase/docs-couchbase-lite/blob/release/3.0/modules/objc/examples/code_snippets/SampleCodeTest.m 
• Swift
  • https://github.com/couchbase/docs-couchbase-lite/blob/release/3.0/modules/swift/examples/code_snippets/SampleCodeTest.swift 

 

For ALL examples listed:

1. Standardise on variable names throughout all examples

• database
• collection
• doc
• dict
• mutable_dict

2. Ensure code is runnable. (The big snippets files don't have to be runnable if they're not already, but please make sure you've tested code locally at least.

Feel free to check in a new example that you've tested, with just the necessary tags, but this is not required.

 

List of code tags to search for and update:

I've mentioned the changes I made (or "check" if I think there are none) but please verify, and make sure the code works.

• datatype_usage_createdb

• • standardise names as above

• datatype_usage_createdoc

• • check 

• datatype_usage_mutdict

• • check 

• datatype_usage_mutarray

• • check 

• datatype_usage_populate

• • check 

• datatype_usage_persist

• • collection.Save instead of database! 

• datatype_usage_closedb

• • check 

• datatype_usage_release (C only)
   

• date-getter (not C)

• • standardised on doc as document var 

• datatype_dictionary

• • collection.GetDocument

• • standardise names (as above) 

• datatype_mutable_dictionary

• • collection.Save

• • standardise names
     

• datatype_array

• • collection.GetDocument

• • standardise names 

• datatype_mutable_array

• • collection.Save

• • standardise names 

• initializer

• • collection.Save

• • standardise names 

• update-document

• • collection.GetDocument 

• • collection.Save

• • standardise names 

• to-dictionary;to-json (Swift only)
   

• batch

• • collection.Save

• • standardise names 

• document-listener

• •  collection.AddDocumentChangeListener
  • collection.GetDocument
  • standardise names
• flow-as-database-change-listener  (Kotlin only, in FlowExamples.kt)
• flow-as-document-change-listener  (Kotlin only, in FlowExamples.kt)

• document-expiration

• • collection.SetDocumentExpiration

• • Datasource.Collection(Collection)

• • standardise names 

• tojson-array

• • Collection.Save
  • Collection.GetDocument
  • standardise names

• tojson-blob

• • (untested for C#)

• • Collection.Save (and SaveBlob presumably)

• • GetDocument etc.

• • standardise names 

• tojson-dictionary

• • check 

• query-get-all;tojson-document
  • collection.GetDocument etc.
• query-access-json
  • check