Skip to content

API Usage

Jens Alfke edited this page Jan 11, 2021 · 7 revisions

This is a list of all LiteCore functions being used by the Couchbase Lite implementations, as of 11 January 2021. The list was generated by the ack tool, with the Unix command line

ack -o --noheading --no-filename '\bc4\w+\(' $SRCDIR | sort | uniq

(postprocessed slightly by hand, to remove the parens and add line breaks between groups.)

Objective-C

SRCDIR="couchbase/couchbase-lite-ios/Objective-C/ couchbaselabs/couchbase-lite-ios-ee/Sources/Objective-C/"

c4_dumpInstances
c4_getObjectCount
c4_getVersion

c4blob_create
c4blob_getContents
c4blob_keyFromString
c4blob_keyToString
c4blob_openReadStream
c4blob_openWriteStream

c4cert_copyData
c4cert_createRequest
c4cert_fromData
c4cert_getPublicKey
c4cert_getValidTimespan
c4cert_isSelfSigned
c4cert_load
c4cert_nextInChain
c4cert_release
c4cert_retain
c4cert_release
c4cert_save
c4cert_signRequest
c4cert_subjectName
c4cert_subjectNameComponent

c4db_beginTransaction
c4db_close
c4db_compact
c4db_copyNamed
c4db_createIndex
c4db_deleteIndex
c4db_deleteNamed
c4db_endTransaction
c4db_getBlobStore
c4db_getCookies
c4db_getDocumentCount
c4db_getFLSharedKeys
c4db_getIndexesInfo
c4db_getPath
c4db_getRemoteDBAddress
c4db_getSharedFleeceEncoder
c4db_getUUIDs
c4db_maintenance
c4db_nextDocExpiration
c4db_openNamed
c4db_purgeDoc
c4db_purgeExpiredDocs
c4db_rekey
c4db_release
c4db_setCookie

c4dbobs_create
c4dbobs_free
c4dbobs_getChanges
c4dbobs_releaseChanges

c4doc_create
c4doc_dictContainsBlobs
c4doc_get
c4doc_getExpiration
c4doc_getRemoteAncestor
c4doc_hasRevisionBody
c4doc_release
c4doc_resolveConflict
c4doc_save
c4doc_selectCommonAncestorRevision
c4doc_selectCurrentRevision
c4doc_selectNextLeafRevision
c4doc_selectNextRevision
c4doc_selectParentRevision
c4doc_selectRevision
c4doc_setExpiration
c4doc_update

c4docobs_create
c4docobs_free

c4error_getMessage
c4error_make

c4keypair_generate
c4keypair_persistentWithPublicKey
c4keypair_removePersistent

c4listener_free
c4listener_getConnectionStatus
c4listener_getPort
c4listener_getURLs
c4listener_shareDB
c4listener_start

c4log_getDomain
c4log_getDomainName
c4log_getLevel
c4log_setBinaryFileLevel
c4log_setCallbackLevel
c4log_setLevel
c4log_writeToBinaryFile
c4log_writeToCallback

c4pred_registerModel
c4pred_unregisterModel

c4query_columnCount
c4query_columnTitle
c4query_explain
c4query_new
c4query_release
c4query_run

c4queryenum_next
c4queryenum_refresh
c4queryenum_release
c4queryenum_seek

c4repl_free
c4repl_getPendingDocIDs
c4repl_getStatus
c4repl_isDocumentPending
c4repl_new
c4repl_newLocal
c4repl_setHostReachable
c4repl_newWithSocket
c4repl_setOptions
c4repl_setSuspended
c4repl_start
c4repl_stop

c4rev_getGeneration

c4slice_free
c4slog

c4socket_closeRequested
c4socket_closed
c4socket_completedWrite
c4socket_fromNative
c4socket_gotHTTPResponse
c4socket_opened
c4socket_received

c4str

c4stream_close
c4stream_closeWriter
c4stream_computeBlobKey
c4stream_install
c4stream_read
c4stream_write

Java

SRCDIR=couchbase/couchbase-lite-java-common/common/main/cpp

c4_getBuildInfo
c4_getVersion
c4_setTempDir

c4address_fromURL

c4blob_create
c4blob_delete
c4blob_deleteStore
c4blob_freeStore
c4blob_getContents
c4blob_getFilePath
c4blob_getSize
c4blob_keyFromString
c4blob_keyToString
c4blob_openReadStream
c4blob_openStore
c4blob_openWriteStream

c4cert_copyData
c4cert_createRequest
c4cert_fromData
c4cert_release
c4cert_signRequest

c4db_URINameFromPath
c4db_beginTransaction
c4db_close
c4db_compact
c4db_copy
c4db_createIndex
c4db_delete
c4db_deleteAtPath
c4db_deleteIndex
c4db_encodeJSON
c4db_endTransaction
c4db_enumerateAllDocs
c4db_enumerateChanges
c4db_getBlobStore
c4db_getConfig
c4db_getCookies
c4db_getDocumentCount
c4db_getFLSharedKeys
c4db_getIndexes
c4db_getLastSequence
c4db_getMaxRevTreeDepth
c4db_getPath
c4db_getSharedFleeceEncoder
c4db_getUUIDs
c4db_maintenance
c4db_nextDocExpiration
c4db_open
c4db_purgeDoc
c4db_purgeExpiredDocs
c4db_rekey
c4db_release
c4db_setCookie
c4db_setMaxRevTreeDepth

c4dbobs_create
c4dbobs_free
c4dbobs_getChanges
c4dbobs_releaseChanges

c4doc_bodyAsJSON
c4doc_create
c4doc_dictContainsBlobs
c4doc_get
c4doc_getBySequence
c4doc_getExpiration
c4doc_hasRevisionBody
c4doc_loadRevisionBody
c4doc_purgeRevision
c4doc_put
c4doc_release
c4doc_resolveConflict
c4doc_save
c4doc_selectCommonAncestorRevision
c4doc_selectCurrentRevision
c4doc_selectFirstPossibleAncestorOf
c4doc_selectNextLeafRevision
c4doc_selectNextPossibleAncestorOf
c4doc_selectNextRevision
c4doc_selectParentRevision
c4doc_setExpiration
c4doc_update

c4docobs_create
c4docobs_free

c4enum_close
c4enum_free
c4enum_getDocument
c4enum_next

c4error_getMessage
c4error_make
c4key_setPassword
c4keypair_fromExternal
c4keypair_release

c4listener_free
c4listener_getConnectionStatus
c4listener_getPort
c4listener_getURLs
c4listener_shareDB
c4listener_start
c4listener_unshareDB

c4log_binaryFileLevel
c4log_enableFatalExceptionBacktrace
c4log_getDomain
c4log_getDomainName
c4log_getLevel
c4log_getWarnOnErrors
c4log_setBinaryFileLevel
c4log_setCallbackLevel
c4log_setLevel
c4log_writeToBinaryFile
c4log_writeToCallback

c4pred_registerModel
c4pred_unregisterModel

c4query_columnCount
c4query_explain
c4query_fullTextMatched
c4query_new
c4query_release
c4query_run

c4queryenum_close
c4queryenum_free
c4queryenum_getRowCount
c4queryenum_next
c4queryenum_refresh
c4queryenum_release
c4queryenum_seek

c4raw_free
c4raw_get
c4raw_put

c4repl_free
c4repl_getPendingDocIDs
c4repl_getStatus
c4repl_isDocumentPending
c4repl_new
c4repl_newLocal
c4repl_newWithSocket
c4repl_setHostReachable
c4repl_setOptions
c4repl_start
c4repl_stop

c4slice_free
c4slog

c4socket_closeRequested
c4socket_closed
c4socket_completedWrite
c4socket_fromNative
c4socket_gotHTTPResponse
c4socket_opened
c4socket_received

c4stream_close
c4stream_closeWriter
c4stream_computeBlobKey
c4stream_getLength
c4stream_install
c4stream_read
c4stream_seek
c4stream_write

.NET

SRCDIR=couchbase/couchbase-lite-net/src/LiteCore/

c4_getObjectCount
c4_getVersion
c4_now
c4_shutdown

c4base_release
c4base_retain

c4blob_create
c4blob_delete
c4blob_deleteStore
c4blob_getContents
c4blob_getFilePath
c4blob_getSize
c4blob_keyFromString
c4blob_keyToString
c4blob_openReadStream
c4blob_openStore
c4blob_openWriteStream

c4cert_copyChainData
c4cert_copyData
c4cert_createRequest
c4cert_fromData
c4cert_getPublicKey
c4cert_getValidTimespan
c4cert_isSelfSigned
c4cert_isSigned
c4cert_load
c4cert_loadPersistentPrivateKey
c4cert_nextInChain
c4cert_release
c4cert_requestFromData
c4cert_retain
c4cert_save
c4cert_sendSigningRequest
c4cert_signRequest
c4cert_subjectName
c4cert_subjectNameAtIndex
c4cert_subjectNameComponent
c4cert_summary
c4cert_usages

c4db_beginTransaction
c4db_close
c4db_compact
c4db_copy
c4db_copyNamed
c4db_createIndex
c4db_delete
c4db_deleteAtPath
c4db_deleteIndex
c4db_deleteNamed
c4db_encodeJSON
c4db_endTransaction
c4db_enumerateAllDocs
c4db_enumerateChanges
c4db_getBlobStore
c4db_getConfig
c4db_getConfig2
c4db_getCookies
c4db_getDocumentCount
c4db_getExtraInfo
c4db_getFLSharedKeys
c4db_getIndexes
c4db_getLastSequence
c4db_getMaxRevTreeDepth
c4db_getPath
c4db_getSharedFleeceEncoder
c4db_getUUIDs
c4db_isInTransaction
c4db_maintenance
c4db_nextDocExpiration
c4db_open
c4db_openNamed
c4db_purgeDoc
c4db_purgeExpiredDocs
c4db_rekey
c4db_release
c4db_retain
c4db_setCookie
c4db_setExtraInfo
c4db_setMaxRevTreeDepth

c4dbobs_create
c4dbobs_free
c4dbobs_getChanges
c4dbobs_releaseChanges

c4doc_create
c4doc_dictContainsBlobs
c4doc_get
c4doc_getBySequence
c4doc_getExpiration
c4doc_hasRevisionBody
c4doc_isOldMetaProperty
c4doc_loadRevisionBody
c4doc_purgeRevision
c4doc_put
c4doc_release
c4doc_resolveConflict
c4doc_retain
c4doc_save
c4doc_selectCommonAncestorRevision
c4doc_selectCurrentRevision
c4doc_selectFirstPossibleAncestorOf
c4doc_selectNextLeafRevision
c4doc_selectNextPossibleAncestorOf
c4doc_selectNextRevision
c4doc_selectParentRevision
c4doc_selectRevision
c4doc_setExpiration
c4doc_update

c4docobs_create
c4docobs_free

c4enum_close
c4enum_free
c4enum_getDocument
c4enum_getDocumentInfo
c4enum_next
c4enum_nextDocument

c4error_getMessage
c4error_make
c4error_mayBeNetworkDependent
c4error_mayBeTransient

c4keypair_fromExternal
c4keypair_fromPrivateKeyData
c4keypair_fromPublicKeyData
c4keypair_generate
c4keypair_hasPrivateKey
c4keypair_isPersistent
c4keypair_persistentWithPublicKey
c4keypair_privateKeyData
c4keypair_publicKeyData
c4keypair_publicKeyDigest
c4keypair_release
c4keypair_removePersistent
c4keypair_retain

c4listener_availableAPIs
c4listener_free
c4listener_getConnectionStatus
c4listener_getPort
c4listener_getURLs
c4listener_shareDB
c4listener_start
c4listener_unshareDB

c4log_binaryFileLevel
c4log_callbackLevel
c4log_getDomain
c4log_getDomainName
c4log_getLevel
c4log_setBinaryFileLevel
c4log_setCallbackLevel
c4log_setLevel
c4log_warnOnErrors
c4log_writeToBinaryFile
c4log_writeToCallback

c4pred_registerModel
c4pred_unregisterModel

c4query_columnCount
c4query_columnTitle
c4query_explain
c4query_new
c4query_new2
c4query_release
c4query_run
c4query_setParameters

c4queryenum_close
c4queryenum_next
c4queryenum_refresh
c4queryenum_release
c4queryenum_retain
c4queryenum_seek

c4raw_free
c4raw_get
c4raw_put

c4repl_free
c4repl_getPeerTLSCertificate
c4repl_getPendingDocIDs
c4repl_getStatus
c4repl_isDocumentPending
c4repl_new
c4repl_newLocal
c4repl_newWithSocket
c4repl_retry
c4repl_setHostReachable
c4repl_setOptions
c4repl_start
c4repl_stop

c4rev_getGeneration

c4slog

c4socket_closeRequested
c4socket_closed
c4socket_completedWrite
c4socket_fromNative
c4socket_gotHTTPResponse
c4socket_opened
c4socket_received
c4socket_registerFactory

c4stream_close
c4stream_closeWriter
c4stream_computeBlobKey
c4stream_getLength
c4stream_install
c4stream_read
c4stream_seek
c4stream_write
Clone this wiki locally