com.couchbase.lite.store

Class SQLiteStore

java.lang.Object

com.couchbase.lite.store.SQLiteStore

All Implemented Interfaces:

EncryptableStore, Store

public class SQLiteStore
extends java.lang.Object
implements Store, EncryptableStore

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	kDBFilename
static java.lang.String	SCHEMA
java.lang.String	TAG

Constructor Summary

Constructors

Constructor and Description
SQLiteStore(java.lang.String directory, Manager manager, StoreDelegate delegate)

Method Summary

Modifier and Type	Method and Description
Action	actionToChangeEncryptionKey(SymmetricKey newKey) Action for changing the encryption key of the storage.
RevisionInternal	add(java.lang.String docID, java.lang.String prevRevID, java.util.Map<java.lang.String,java.lang.Object> properties, boolean deleting, boolean allowConflict, StorageValidation validationBlock, Status outStatus) Creates a new revision of a document.
protected boolean	beginTransaction() Begins a storageEngine transaction.
RevisionList	changesSince(long lastSequence, ChangesOptions options, ReplicationFilter filter, java.util.Map<java.lang.String,java.lang.Object> filterParams) Returns all database changes with sequences greater than `lastSequence`.
void	close() Closes storage before it's deallocated.
void	compact() Explicitly compacts document storage.
boolean	databaseExists(java.lang.String directory) Preflight to see if a database file exists in this directory.
byte[]	derivePBKDF2SHA256Key(java.lang.String password, byte[] salt, int rounds) A utility method for deriving PBKDF2-SHA256 based key from the password.
protected java.util.Map<java.lang.String,java.lang.Object>	documentPropertiesFromJSON(byte[] json, java.lang.String docID, java.lang.String revID, boolean deleted, long sequence)
protected boolean	endTransaction(boolean commit) Commits or aborts (rolls back) a transaction.
long	expirationOfDocument(java.lang.String docID) Returns a document's expiration date as a Unix timestamp, or 0 for no expiration.
java.util.Set<BlobKey>	findAllAttachmentKeys() - (NSSet*) findAllAttachmentKeys: (NSError**)outError
java.lang.String	findCommonAncestorOf(RevisionInternal rev, java.util.List<java.lang.String> revIDs) Returns the most recent member of revIDs that appears in rev's ancestry.
int	findMissingRevisions(RevisionList touchRevs) Looks for each given revision in the local database, and removes each one found from the list.
void	forceInsert(RevisionInternal inRev, java.util.List<java.lang.String> history, StorageValidation validationBlock, java.net.URL source) Inserts an already-existing revision replicated from a remote sqliteDb.
java.util.Map<java.lang.String,java.lang.Object>	getAllDocs(QueryOptions options) - (CBLQueryIteratorBlock) getAllDocs: (CBLQueryOptions*)options status: (CBLStatus*)outStatus
RevisionList	getAllRevisions(java.lang.String docID, boolean onlyCurrent) Returns all the known revisions (or all current/conflicting revisions) of a document.
java.util.List<java.lang.String>	getAllViewNames() Returns the names of all existing views in the database.
boolean	getAutoCompact()
StoreDelegate	getDelegate()
protected long	getDocNumericID(java.lang.String docID)
protected RevisionInternal	getDocument(java.lang.String docID, long sequence) Loads revision given its sequence.
RevisionInternal	getDocument(java.lang.String docID, java.lang.String revID, boolean withBody, Status outStatus) Retrieves a document revision by ID.
int	getDocumentCount() The number of (undeleted) documents in the database.
SymmetricKey	getEncryptionKey() Return current encryption key
java.lang.String	getInfo(java.lang.String key) Returns the value assigned to the given key by -setInfo:forKey:.
long	getLastSequence() The latest sequence number used.
RevisionInternal	getLocalDocument(java.lang.String docID, java.lang.String revID) Returns the contents of a local document.
int	getMaxRevTreeDepth() Get the maximum depth of a document's revision tree (or, max length of its revision history.) Revisions older than this limit will be deleted during a -compact: operation.
RevisionInternal	getParentRevision(RevisionInternal rev) Retrieves the parent revision of a revision, or returns nil if there is no parent.
java.util.List<java.lang.String>	getPossibleAncestorRevisionIDs(RevisionInternal rev, int limit, java.util.concurrent.atomic.AtomicBoolean outHaveBodies, boolean withBodiesOnly) Returns IDs of local revisions of the same document, that have a lower generation number.
java.util.List<RevisionInternal>	getRevisionHistory(RevisionInternal rev) Returns an array of TDRevs in reverse chronological order, starting with the given revision.
protected SQLiteStorageEngine	getStorageEngine()
ViewStore	getViewStorage(java.lang.String name, boolean create) Instantiates storage for a view.
boolean	inTransaction() Is a transaction active?
RevisionInternal	loadRevisionBody(RevisionInternal rev) Loads the body of a revision.
long	nextDocumentExpiry() Returns the next time at which a document will expire.
void	open() Opens storage.
protected void	optimizeSQLIndexes() https://github.com/couchbase/couchbase-lite-ios/issues/615
protected int	pruneDocument(java.lang.String docID, long docNumericID, int minGenToKeep)
protected int	pruneRevsToMaxDepth(int maxDepth) Prune revisions to the given max depth.
int	purgeExpiredDocuments() Triggers purging of documents whose expiration time has passed.
java.util.Map<java.lang.String,java.lang.Object>	purgeRevisions(java.util.Map<java.lang.String,java.util.List<java.lang.String>> docsToRevs) Purges specific revisions, which deletes them completely from the local storageEngine _without_ adding a "tombstone" revision.
RevisionInternal	putLocalRevision(RevisionInternal revision, java.lang.String prevRevID, boolean obeyMVCC) Creates / updates / deletes a local document.
protected RevisionInternal	putLocalRevisionNoMVCC(RevisionInternal revision) - (CBL_Revision*) putLocalRevisionNoMVCC: (CBL_Revision*)revision status: (CBLStatus*)outStatus
protected static RevisionInternal	revision(java.lang.String docID, java.lang.String revID, boolean deleted, long sequence, byte[] json)
protected static RevisionInternal	revision(java.lang.String docID, java.lang.String revID, boolean deleted, long sequence, java.util.Map<java.lang.String,java.lang.Object> properties)
boolean	runInTransaction(TransactionalTask transactionalTask) Executes the block within a database transaction.
protected void	runStatements(java.lang.String statements)
void	setAutoCompact(boolean value) Whether the database storage should automatically (periodically) be compacted.
void	setDelegate(StoreDelegate delegate) The delegate object, which in practice is the CBLDatabase.
void	setEncryptionKey(SymmetricKey key) Set encryption key for opening the storage.
boolean	setExpirationOfDocument(long unixTime, java.lang.String docID) Sets a document's expiration to a Unix timestamp, or 0 for no expiration.
long	setInfo(java.lang.String key, java.lang.String info) Stores an arbitrary string under an arbitrary key, persistently.
void	setMaxRevTreeDepth(int maxRevTreeDepth) Set the maximum depth of a document's revision tree (or, max length of its revision history.) Revisions older than this limit will be deleted during a -compact: operation.
protected java.lang.String	winningRevIDOfDocNumericID(long docNumericId, java.util.concurrent.atomic.AtomicBoolean outIsDeleted, java.util.concurrent.atomic.AtomicBoolean outIsConflict) Returns the rev ID of the 'winning' revision of this document, and whether it's deleted.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TAG

public java.lang.String TAG

kDBFilename

public static java.lang.String kDBFilename

SCHEMA

public static final java.lang.String SCHEMA

See Also:

Constant Field Values

Constructor Detail

SQLiteStore

public SQLiteStore(java.lang.String directory,
                   Manager manager,
                   StoreDelegate delegate)
            throws CouchbaseLiteException

Throws:

CouchbaseLiteException

Method Detail

databaseExists

public boolean databaseExists(java.lang.String directory)

Description copied from interface: Store

Preflight to see if a database file exists in this directory. Called _before_ open() method!

Specified by:

databaseExists in interface Store

open

public void open()
          throws CouchbaseLiteException

Description copied from interface: Store

Opens storage. Files will be created in the directory, which must already exist.

Specified by:

open in interface Store

Throws:

CouchbaseLiteException

close

public void close()

Description copied from interface: Store

Closes storage before it's deallocated.

Specified by:

close in interface Store

setDelegate

public void setDelegate(StoreDelegate delegate)

Description copied from interface: Store

The delegate object, which in practice is the CBLDatabase.

Specified by:

setDelegate in interface Store

getDelegate

public StoreDelegate getDelegate()

Specified by:

getDelegate in interface Store

setMaxRevTreeDepth

public void setMaxRevTreeDepth(int maxRevTreeDepth)

Set the maximum depth of a document's revision tree (or, max length of its revision history.) Revisions older than this limit will be deleted during a -compact: operation. Smaller values save space, at the expense of making document conflicts somewhat more likely.

Specified by:

setMaxRevTreeDepth in interface Store

getMaxRevTreeDepth

public int getMaxRevTreeDepth()

Get the maximum depth of a document's revision tree (or, max length of its revision history.) Revisions older than this limit will be deleted during a -compact: operation. Smaller values save space, at the expense of making document conflicts somewhat more likely.

Specified by:

getMaxRevTreeDepth in interface Store

setAutoCompact

public void setAutoCompact(boolean value)

Description copied from interface: Store

Whether the database storage should automatically (periodically) be compacted. This will be set soon after the open() method call.

Specified by:

setAutoCompact in interface Store

getAutoCompact

public boolean getAutoCompact()

Specified by:

getAutoCompact in interface Store

setEncryptionKey

public void setEncryptionKey(SymmetricKey key)

Description copied from interface: EncryptableStore

Set encryption key for opening the storage.

Specified by:

setEncryptionKey in interface EncryptableStore

Parameters:

key - a SymmetricKey object

getEncryptionKey

public SymmetricKey getEncryptionKey()

Description copied from interface: EncryptableStore

Return current encryption key

Specified by:

getEncryptionKey in interface EncryptableStore

Returns:

a SymmetricKey object

actionToChangeEncryptionKey

public Action actionToChangeEncryptionKey(SymmetricKey newKey)

Description copied from interface: EncryptableStore

Action for changing the encryption key of the storage.

Specified by:

actionToChangeEncryptionKey in interface EncryptableStore

Parameters:

newKey - a new SymmetricKey object

Returns:

an Action object

derivePBKDF2SHA256Key

public byte[] derivePBKDF2SHA256Key(java.lang.String password,
                                    byte[] salt,
                                    int rounds)
                             throws CouchbaseLiteException

Description copied from interface: EncryptableStore

A utility method for deriving PBKDF2-SHA256 based key from the password.

Specified by:

derivePBKDF2SHA256Key in interface EncryptableStore

Parameters:

password - password

salt - salt

rounds - number of rounds

Returns:

a derived PBKDF2-SHA256 key

Throws:

CouchbaseLiteException

setInfo

public long setInfo(java.lang.String key,
                    java.lang.String info)

Description copied from interface: Store

Stores an arbitrary string under an arbitrary key, persistently.

Specified by:

setInfo in interface Store

getInfo

public java.lang.String getInfo(java.lang.String key)

Description copied from interface: Store

Returns the value assigned to the given key by -setInfo:forKey:.

Specified by:

getInfo in interface Store

getDocumentCount

public int getDocumentCount()

Description copied from interface: Store

The number of (undeleted) documents in the database.

Specified by:

getDocumentCount in interface Store

getLastSequence

public long getLastSequence()

The latest sequence number used. Every new revision is assigned a new sequence number, so this property increases monotonically as changes are made to the storageEngine. It can be used to check whether the storageEngine has changed between two points in time.

Specified by:

getLastSequence in interface Store

inTransaction

public boolean inTransaction()

Is a transaction active?

Specified by:

inTransaction in interface Store

compact

public void compact()
             throws CouchbaseLiteException

Description copied from interface: Store

Explicitly compacts document storage.

Specified by:

compact in interface Store

Throws:

CouchbaseLiteException

runInTransaction

public boolean runInTransaction(TransactionalTask transactionalTask)

Description copied from interface: Store

Executes the block within a database transaction. If the block returns a non-OK status, the transaction is aborted/rolled back. If the block returns kCBLStatusDBBusy, the block will also be retried after a short delay; if 10 retries all fail, the kCBLStatusDBBusy will be returned to the caller. Any exception raised by the block will be caught and treated as kCBLStatusException.

Specified by:

runInTransaction in interface Store

getDocument

public RevisionInternal getDocument(java.lang.String docID,
                                    java.lang.String revID,
                                    boolean withBody,
                                    Status outStatus)

Description copied from interface: Store

Retrieves a document revision by ID.

Specified by:

getDocument in interface Store

Parameters:

docID - The document ID

revID - The revision ID; may be nil, meaning "the current revision".

withBody - If false, revision's body won't be loaded

Returns:

The revision, or nil if not found.

loadRevisionBody

public RevisionInternal loadRevisionBody(RevisionInternal rev)
                                  throws CouchbaseLiteException

Description copied from interface: Store

Loads the body of a revision. On entry, rev.docID and rev.revID will be valid. On success, rev.body and rev.sequence will be valid.

Specified by:

loadRevisionBody in interface Store

Throws:

CouchbaseLiteException

getParentRevision

public RevisionInternal getParentRevision(RevisionInternal rev)

Description copied from interface: Store

Retrieves the parent revision of a revision, or returns nil if there is no parent.

Specified by:

getParentRevision in interface Store

getRevisionHistory

public java.util.List<RevisionInternal> getRevisionHistory(RevisionInternal rev)

Returns an array of TDRevs in reverse chronological order, starting with the given revision.

Specified by:

getRevisionHistory in interface Store

getPossibleAncestorRevisionIDs

public java.util.List<java.lang.String> getPossibleAncestorRevisionIDs(RevisionInternal rev,
                                                                       int limit,
                                                                       java.util.concurrent.atomic.AtomicBoolean outHaveBodies,
                                                                       boolean withBodiesOnly)

Description copied from interface: Store

Returns IDs of local revisions of the same document, that have a lower generation number. If possible, returns only leaf revisions; if none match, returns non-leaves.

Specified by:

getPossibleAncestorRevisionIDs in interface Store

Parameters:

rev - The revision to look for ancestors of. Only its docID and revID are used.

limit - The maximum number of results to return, or if 0, unlimited.

outHaveBodies - On return, if not NULL, then *outHaveBodies will be YES if all the revisions returned have their JSON bodies available, otherwise NO.

withBodiesOnly - Specifies whether or not to search for non-empty and non-removed revisions.

Returns:

An array of revIDs of existing revisions that could be ancestors of `rev`.

findCommonAncestorOf

public java.lang.String findCommonAncestorOf(RevisionInternal rev,
                                             java.util.List<java.lang.String> revIDs)

Returns the most recent member of revIDs that appears in rev's ancestry.

Specified by:

findCommonAncestorOf in interface Store

findMissingRevisions

public int findMissingRevisions(RevisionList touchRevs)
                         throws SQLException

Description copied from interface: Store

Looks for each given revision in the local database, and removes each one found from the list. On return, therefore, `revs` will contain only the revisions that don't exist locally.

Specified by:

findMissingRevisions in interface Store

Throws:

SQLException

findAllAttachmentKeys

public java.util.Set<BlobKey> findAllAttachmentKeys()
                                             throws CouchbaseLiteException

- (NSSet*) findAllAttachmentKeys: (NSError**)outError

Specified by:

findAllAttachmentKeys in interface Store

Throws:

CouchbaseLiteException

getAllDocs

public java.util.Map<java.lang.String,java.lang.Object> getAllDocs(QueryOptions options)
                                                            throws CouchbaseLiteException

- (CBLQueryIteratorBlock) getAllDocs: (CBLQueryOptions*)options status: (CBLStatus*)outStatus

Specified by:

getAllDocs in interface Store

Throws:

CouchbaseLiteException

changesSince

public RevisionList changesSince(long lastSequence,
                                 ChangesOptions options,
                                 ReplicationFilter filter,
                                 java.util.Map<java.lang.String,java.lang.Object> filterParams)

Description copied from interface: Store

Returns all database changes with sequences greater than `lastSequence`.

Specified by:

changesSince in interface Store

Parameters:

lastSequence - The sequence number to start _after_

options - Options for ordering, document content, etc.

filter - If non-nil, will be called on every revision, and those for which it returns NO will be skipped.

Returns:

The list of CBL_Revisions

add

public RevisionInternal add(java.lang.String docID,
                            java.lang.String prevRevID,
                            java.util.Map<java.lang.String,java.lang.Object> properties,
                            boolean deleting,
                            boolean allowConflict,
                            StorageValidation validationBlock,
                            Status outStatus)
                     throws CouchbaseLiteException

Creates a new revision of a document. On success, before returning the new CBL_Revision, the implementation will also call the delegate's -databaseStorageChanged: method to give it more details about the change.

Specified by:

add in interface Store

Parameters:

docID - The document ID, or nil if an ID should be generated at random.

prevRevID - The parent revision ID, or nil if creating a new document.

properties - The new revision's properties. (Metadata other than "_attachments" ignored.)

deleting - YES if this revision is a deletion.

allowConflict - YES if this operation is allowed to create a conflict; otherwise a 409, status will be returned if the parent revision is not a leaf.

validationBlock - If non-nil, this block will be called before the revision is added. It's given the parent revision, with its properties if available, and can reject the operation by returning an error status.

outStatus - On return a status will be stored here. Note that on success, the status should be 201 for a created revision but 200 for a deletion.

Returns:

The new revision, with its revID and sequence filled in, or nil on error.

Throws:

CouchbaseLiteException

forceInsert

public void forceInsert(RevisionInternal inRev,
                        java.util.List<java.lang.String> history,
                        StorageValidation validationBlock,
                        java.net.URL source)
                 throws CouchbaseLiteException

Inserts an already-existing revision replicated from a remote sqliteDb.

It must already have a revision ID. This may create a conflict! The revision's history must be given; ancestor revision IDs that don't already exist locally will create phantom revisions with no content.

Specified by:

forceInsert in interface Store

Parameters:

inRev - The revision to insert. Its revID will be non-nil.

history - The revIDs of the revision and its ancestors, in reverse chronological order. The first item will be equal to inRev.revID.

validationBlock - If non-nil, this block will be called before the revision is added. It's given the parent revision, with its properties if available, and can reject the operation by returning an error status.

source - The URL of the remote database this was pulled from, or nil if it's local. (This will be used to create the CBLDatabaseChange object sent to the delegate.)

Throws:

CouchbaseLiteException

purgeRevisions

public java.util.Map<java.lang.String,java.lang.Object> purgeRevisions(java.util.Map<java.lang.String,java.util.List<java.lang.String>> docsToRevs)

Purges specific revisions, which deletes them completely from the local storageEngine _without_ adding a "tombstone" revision. It's as though they were never there. This operation is described here: http://wiki.apache.org/couchdb/Purge_Documents

Specified by:

purgeRevisions in interface Store

Parameters:

docsToRevs - A dictionary mapping document IDs to arrays of revision IDs.

Returns:

On success will point to an NSDictionary with the same form as docsToRev, containing the doc/revision IDs that were actually removed.

expirationOfDocument

public long expirationOfDocument(java.lang.String docID)

Description copied from interface: Store

Returns a document's expiration date as a Unix timestamp, or 0 for no expiration.

Specified by:

expirationOfDocument in interface Store

Returns:

Java Time

setExpirationOfDocument

public boolean setExpirationOfDocument(long unixTime,
                                       java.lang.String docID)

Description copied from interface: Store

Sets a document's expiration to a Unix timestamp, or 0 for no expiration.

Specified by:

setExpirationOfDocument in interface Store

nextDocumentExpiry

public long nextDocumentExpiry()

Description copied from interface: Store

Returns the next time at which a document will expire.

Specified by:

nextDocumentExpiry in interface Store

Returns:

Java Time

purgeExpiredDocuments

public int purgeExpiredDocuments()

Description copied from interface: Store

Triggers purging of documents whose expiration time has passed.

Specified by:

purgeExpiredDocuments in interface Store

getViewStorage

public ViewStore getViewStorage(java.lang.String name,
                                boolean create)
                         throws CouchbaseLiteException

Instantiates storage for a view.

Specified by:

getViewStorage in interface Store

Parameters:

name - The name of the view

create - If YES, the view should be created; otherwise it must already exist

Returns:

Storage for the view, or nil if create=NO and it doesn't exist.

Throws:

CouchbaseLiteException

getAllViewNames

public java.util.List<java.lang.String> getAllViewNames()

Description copied from interface: Store

Returns the names of all existing views in the database.

Specified by:

getAllViewNames in interface Store

getLocalDocument

public RevisionInternal getLocalDocument(java.lang.String docID,
                                         java.lang.String revID)

Description copied from interface: Store

Returns the contents of a local document. Note that local documents do not have revision histories, so only the current revision exists.

Specified by:

getLocalDocument in interface Store

Parameters:

docID - The document ID, which will begin with "_local/"

revID - revID The revision ID, or nil to return the current revision.

Returns:

A revision containing the body of the document, or nil if not found.

putLocalRevision

public RevisionInternal putLocalRevision(RevisionInternal revision,
                                         java.lang.String prevRevID,
                                         boolean obeyMVCC)
                                  throws CouchbaseLiteException

Description copied from interface: Store

Creates / updates / deletes a local document.

Specified by:

putLocalRevision in interface Store

Parameters:

revision - The new revision to save. Its docID must be set but the revID is ignored. If its .deleted property is YES, it's a deletion.

prevRevID - The revision ID to replace

obeyMVCC - If YES, the prevRevID must match the document's current revID (or nil if the document doesn't exist) or a 409 error is returned. If NO, the prevRevID is ignored and the operation always succeeds.

Returns:

The new revision, with revID filled in, or nil on error.

Throws:

CouchbaseLiteException

putLocalRevisionNoMVCC

protected RevisionInternal putLocalRevisionNoMVCC(RevisionInternal revision)
                                           throws CouchbaseLiteException

- (CBL_Revision*) putLocalRevisionNoMVCC: (CBL_Revision*)revision status: (CBLStatus*)outStatus

Throws:

CouchbaseLiteException

getAllRevisions

public RevisionList getAllRevisions(java.lang.String docID,
                                    boolean onlyCurrent)

Description copied from interface: Store

Returns all the known revisions (or all current/conflicting revisions) of a document.

Specified by:

getAllRevisions in interface Store

Parameters:

docID - The document ID

onlyCurrent - If true, only leaf revisions (whether or not deleted) should be returned.

Returns:

An array of all available revisions of the document.

getStorageEngine

protected SQLiteStorageEngine getStorageEngine()

winningRevIDOfDocNumericID

protected java.lang.String winningRevIDOfDocNumericID(long docNumericId,
                                                      java.util.concurrent.atomic.AtomicBoolean outIsDeleted,
                                                      java.util.concurrent.atomic.AtomicBoolean outIsConflict)
                                               throws CouchbaseLiteException

Returns the rev ID of the 'winning' revision of this document, and whether it's deleted.

in CBLDatabase+Internal.m - (NSString*) winningRevIDOfDocNumericID: (SInt64)docNumericID isDeleted: (BOOL*)outIsDeleted isConflict: (BOOL*)outIsConflict // optional status: (CBLStatus*)outStatus

Throws:

CouchbaseLiteException

optimizeSQLIndexes

protected void optimizeSQLIndexes()

https://github.com/couchbase/couchbase-lite-ios/issues/615

beginTransaction

protected boolean beginTransaction()

Begins a storageEngine transaction. Transactions can nest. Every beginTransaction() must be balanced by a later endTransaction()

Notes: 1. SQLiteDatabase.beginTransaction() supported nested transaction. But, in case nested transaction rollbacked, it also rollbacks outer transaction too. This is not ideal behavior for CBL 2. SAVEPOINT...RELEASE supports nested transaction. But Android API 14 and 15, it throws Exception. I assume it is Android bug. As CBL need to support from API 10 . So it does not work for CBL. 3. Using Transaction for outer/1st level of transaction and inner/2nd level of transaction works with CBL requirement. 4. CBL Android and Java uses Thread, So it is better to use SQLiteDatabase.beginTransaction() for outer/1st level transaction. if we use BEGIN...COMMIT and SAVEPOINT...RELEASE, we need to implement wrapper of BEGIN...COMMIT and SAVEPOINT...RELEASE to be Thread-safe.

endTransaction

protected boolean endTransaction(boolean commit)

Commits or aborts (rolls back) a transaction.

Parameters:

commit - If true, commits; if false, aborts and rolls back, undoing all changes made since the matching -beginTransaction call, *including* any committed nested transactions.

documentPropertiesFromJSON

protected java.util.Map<java.lang.String,java.lang.Object> documentPropertiesFromJSON(byte[] json,
                                                                                      java.lang.String docID,
                                                                                      java.lang.String revID,
                                                                                      boolean deleted,
                                                                                      long sequence)

pruneRevsToMaxDepth

protected int pruneRevsToMaxDepth(int maxDepth)
                           throws CouchbaseLiteException

Prune revisions to the given max depth. Eg, remove revisions older than that max depth, which will reduce storage requirements.

TODO: This implementation is a bit simplistic. It won't do quite the right thing in histories with branches, if one branch stops much earlier than another. The shorter branch will be deleted entirely except for its leaf revision. A more accurate pruning would require an expensive full tree traversal. Hopefully this way is good enough.

Throws:

CouchbaseLiteException

pruneDocument

protected int pruneDocument(java.lang.String docID,
                            long docNumericID,
                            int minGenToKeep)

runStatements

protected void runStatements(java.lang.String statements)
                      throws SQLException

Throws:

SQLException

getDocNumericID

protected long getDocNumericID(java.lang.String docID)

getDocument

protected RevisionInternal getDocument(java.lang.String docID,
                                       long sequence)

Loads revision given its sequence. Assumes the given docID is valid.

revision

protected static RevisionInternal revision(java.lang.String docID,
                                           java.lang.String revID,
                                           boolean deleted,
                                           long sequence,
                                           byte[] json)

revision

protected static RevisionInternal revision(java.lang.String docID,
                                           java.lang.String revID,
                                           boolean deleted,
                                           long sequence,
                                           java.util.Map<java.lang.String,java.lang.Object> properties)