Raw Documents

Data Structures
struct	C4RawDocument
	Contents of a raw document. More...

Macros
#define	kC4InfoStore   C4STR("info")
#define	kC4LocalDocStore   C4STR("_local")

Functions
NODISCARD CBL_CORE_API C4RawDocument *	c4raw_get (C4Database *database, C4String storeName, C4String docID, C4Error *outError)
	Reads a raw document from the database.
NODISCARD CBL_CORE_API bool	c4raw_put (C4Database *database, C4String storeName, C4String key, C4String meta, C4String body, C4Error *outError)
	Writes a raw document to the database, or deletes it if both meta and body are NULL.

Detailed Description

Macro Definition Documentation

kC4InfoStore

#define kC4InfoStore   C4STR("info")

kC4LocalDocStore

#define kC4LocalDocStore   C4STR("_local")

Function Documentation

c4raw_get()

NODISCARD CBL_CORE_API C4RawDocument * c4raw_get	(	C4Database *	database,
		C4String	storeName,
		C4String	docID,
		C4Error *	outError )

Reads a raw document from the database.

In Couchbase Lite the store named "info" is used for per-database key/value pairs, and the store "_local" is used for local documents.

Note

The caller must use a lock for Database when this function is called.

c4raw_put()

NODISCARD CBL_CORE_API bool c4raw_put	(	C4Database *	database,
		C4String	storeName,
		C4String	key,
		C4String	meta,
		C4String	body,
		C4Error *	outError )

Writes a raw document to the database, or deletes it if both meta and body are NULL.

Note

The caller must use a lock for Database when this function is called.