com.couchbase.lite

Class Database

java.lang.Object

com.couchbase.lite.Database

All Implemented Interfaces:

StoreDelegate

public class Database
extends java.lang.Object
implements StoreDelegate

A CouchbaseLite Database.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Database.ChangeEvent The type of event raised when a Database changes.
static interface	Database.ChangeListener A delegate that can be used to listen for Database changes.
static interface	Database.DatabaseListener

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_MAX_REVS
static int	kBigAttachmentLength
static java.lang.String	kCBLDatabaseLocalCheckpoint_LocalUUID
static java.lang.String	kLocalCheckpointDocId
static java.lang.String	TAG

Constructor Summary

Constructors

Constructor and Description
Database(java.lang.String path, java.lang.String name, Manager manager, boolean readOnly) Constructor

Method Summary

Modifier and Type	Method and Description
void	addActiveReplication(Replication replication)
void	addChangeListener(Database.ChangeListener listener) Adds a Database change delegate that will be called whenever a Document within the Database changes.
void	addDatabaseListener(Database.DatabaseListener listener)
void	changeEncryptionKey(java.lang.Object newKeyOrPassword) Changes the database's encryption key, or removes encryption if the new key is null.
RevisionList	changesSince(long lastSeq, ChangesOptions options, ReplicationFilter filter, java.util.Map<java.lang.String,java.lang.Object> filterParams)
protected void	clearDocumentCache() Empties the cache of recently used Document objects.
boolean	close()
void	compact() Compacts the database file by purging non-current JSON bodies, pruning revisions older than the maxRevTreeDepth, deleting unused attachment files, and vacuuming the SQLite database.
Query	createAllDocumentsQuery() Returns a query that matches all documents in the database.
Document	createDocument() Creates a new Document object with no properties and a new (random) UUID.
Replication	createPullReplication(java.net.URL remote) Creates a new Replication that will pull from the source Database at the given url.
Replication	createPushReplication(java.net.URL remote) Creates a new Replication that will push to the target Database at the given url.
void	databaseStorageChanged(DocumentChange change) in CBLDatabase+Internal.m - (void) databaseStorageChanged:(CBLDatabaseChange *)change
void	delete() Deletes the database.
boolean	deleteLocalDocument(java.lang.String localDocID) Deletes the local document with the given ID.
boolean	exists()
boolean	expandAttachments(RevisionInternal rev, int minRevPos, boolean allowFollows, boolean decodeAttachments, Status outStatus) Modifies a CBL_Revision's _attachments dictionary by adding the "data" property to all attachments (and removing "stub" and "follows".) GZip-encoded attachments will be unzipped unless options contains the flag kCBLLeaveAttachmentsEncoded.
protected long	expirationOfDocument(java.lang.String docID)
java.net.URL	fileForAttachmentDict(java.util.Map<java.lang.String,java.lang.Object> attachmentDict)
protected Replication	findActiveReplicator(Replication replicator)
java.lang.String	findCommonAncestorOf(RevisionInternal rev, java.util.List<java.lang.String> revIDs)
int	findMissingRevisions(RevisionList touchRevs)
void	forceInsert(RevisionInternal inRev, java.util.List<java.lang.String> history, java.net.URL source) Inserts an already-existing revision replicated from a remote sqliteDb.
protected void	forgetView(java.lang.String name) in CBLDatabase+Internal.m - (void) forgetViewNamed: (NSString*)name
java.lang.String	generateRevID(byte[] json, boolean deleted, java.lang.String prevRevID) Generates a revision ID for a new revision.
java.util.Map<java.lang.String,java.lang.Object>	getAllDocs(QueryOptions options)
java.util.List<Replication>	getAllReplications() Get all the replicators associated with this database.
RevisionList	getAllRevisions(java.lang.String docID, boolean onlyCurrent)
protected java.util.List<View>	getAllViews() NOTE: Only used by Unit Tests
AttachmentInternal	getAttachment(java.util.Map info, java.lang.String filename)
AttachmentInternal	getAttachment(RevisionInternal rev, java.lang.String filename)
protected java.util.Map<java.lang.String,java.lang.Object>	getAttachments(java.lang.String docID, java.lang.String revID) - (NSDictionary*) attachmentsForDocID: (NSString*)docID revID: (NSString*)revID status: (CBLStatus*)outStatus
BlobStore	getAttachmentStore()
protected java.lang.String	getAttachmentStorePath()
BlobStoreWriter	getAttachmentWriter()
protected Document	getCachedDocument(java.lang.String documentID) Returns the already-instantiated cached Document with the given ID, or nil if none is yet cached.
Document	getDocument(java.lang.String documentId) Instantiates a Document object with the given ID.
RevisionInternal	getDocument(java.lang.String docID, java.lang.String revID, boolean withBody)
RevisionInternal	getDocument(java.lang.String docID, java.lang.String revID, boolean withBody, Status outStatus)
int	getDocumentCount() The number of documents in the database.
Document	getExistingDocument(java.lang.String docID) Gets the Document with the given id, or null if it does not exist.
java.util.Map<java.lang.String,java.lang.Object>	getExistingLocalDocument(java.lang.String documentId) Returns the contents of the local document with the given ID, or nil if none exists.
View	getExistingView(java.lang.String name) Returns the existing View with the given name, or nil if none.
ReplicationFilter	getFilter(java.lang.String filterName) Returns the existing filter function (block) registered with the given name.
static ReplicationFilterCompiler	getFilterCompiler() Returns the currently registered filter compiler (nil by default).
protected java.lang.String	getInfo(java.lang.String key)
long	getLastSequenceNumber() The latest sequence number used.
protected java.util.Map<java.lang.String,java.lang.Object>	getLocalCheckpointDocument() Returns local checkpoint document if it exists.
protected java.lang.Object	getLocalCheckpointDocumentPropertyValueForKey(java.lang.String key) Returns a property value specifiec by the key from the local checkpoint document.
RevisionInternal	getLocalDocument(java.lang.String docID, java.lang.String revID)
Manager	getManager() The database manager that owns this database.
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.
java.lang.String	getName() Get the database's name.
protected RevisionInternal	getParentRevision(RevisionInternal rev)
protected java.lang.String	getPath()
PersistentCookieJar	getPersistentCookieStore() Get the PersistentCookieStore associated with this database.
java.util.List<java.lang.String>	getPossibleAncestorRevisionIDs(RevisionInternal rev, int limit, java.util.concurrent.atomic.AtomicBoolean hasAttachment, boolean withBodiesOnly) NOTE: This method is internal use only (from BulkDownloader and PullerInternal)
java.util.List<RevisionInternal>	getRevisionHistory(RevisionInternal rev) Returns an array of TDRevs in reverse chronological order, starting with the given revision.
java.util.Map<java.lang.String,java.lang.Object>	getRevisionHistoryDictStartingFromAnyAncestor(RevisionInternal rev, java.util.List<java.lang.String> ancestorRevIDs) Returns the revision history as a _revisions dictionary, as returned by the REST API's ?revs=true option.
long	getStartTime()
protected Store	getStore()
Validator	getValidation(java.lang.String name) Returns the existing document validation function (block) registered with the given name.
View	getView(java.lang.String name) Returns a View object for the view with the given name.
protected java.lang.String	getViewDocumentType(java.lang.String viewName) Get the document type for the given view name.
protected ViewStore	getViewStorage(java.lang.String name, boolean create)
boolean	inlineFollowingAttachmentsIn(RevisionInternal rev)
boolean	isOpen() Is the database open?
java.lang.String	lastSequenceWithCheckpointId(java.lang.String checkpointId)
RevisionInternal	loadRevisionBody(RevisionInternal rev)
protected View	makeAnonymousView()
void	open()
void	open(DatabaseOptions options)
static java.util.List<java.lang.String>	parseCouchDBRevisionHistory(java.util.Map<java.lang.String,java.lang.Object> docProperties) Parses the _revisions dict from a document into an array of revision ID strings
java.lang.String	privateUUID()
java.lang.String	publicUUID()
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 database _without_ adding a "tombstone" revision.
RevisionInternal	put(java.lang.String docID, java.util.Map<java.lang.String,java.lang.Object> properties, java.lang.String prevRevID, boolean allowConflict, java.net.URL source, Status outStatus)
protected boolean	putLocalCheckpointDocumentWithKey(java.lang.String key, java.lang.Object value) Put a property with a given key and value into the local checkpoint document.
boolean	putLocalDocument(java.lang.String localDocID, java.util.Map<java.lang.String,java.lang.Object> properties) Sets the contents of the local document with the given ID.
RevisionInternal	putLocalRevision(RevisionInternal revision, java.lang.String prevRevID, boolean obeyMVCC)
RevisionInternal	putRevision(RevisionInternal rev, java.lang.String prevRevId, boolean allowConflict)
RevisionInternal	putRevision(RevisionInternal putRev, java.lang.String inPrevRevID, boolean allowConflict, Status outStatus)
protected java.util.List<QueryRow>	queryViewNamed(java.lang.String viewName, QueryOptions options, java.util.List<java.lang.Long> outLastSequence) Reference: In CBLQuery.m - (CBLQueryEnumerator*) queryViewNamed: (NSString*)viewName options: (CBLQueryOptions*)options ifChangedSince: (SequenceNumber)ifChangedSince status: (CBLStatus*)outStatus
protected void	rememberAttachmentWriter(BlobStoreWriter writer)
protected void	rememberAttachmentWriter(BlobStoreWriter writer, java.lang.String digest)
void	rememberAttachmentWritersForDigests(java.util.Map<java.lang.String,BlobStoreWriter> blobsByDigest)
void	rememberPendingKey(BlobKey key, java.lang.String digest)
void	removeChangeListener(Database.ChangeListener listener) Removes the specified delegate as a listener for the Database change event.
void	removeDatabaseListener(Database.DatabaseListener listener)
protected void	removeDocumentFromCache(Document document)
protected boolean	replaceUUIDs()
java.util.concurrent.Future	runAsync(AsyncTask asyncTask) Runs the delegate asynchronously.
boolean	runFilter(ReplicationFilter filter, java.util.Map<java.lang.String,java.lang.Object> filterParams, RevisionInternal rev)
boolean	runInTransaction(TransactionalTask task) Runs the block within a transaction.
protected boolean	saveLocalUUIDInLocalCheckpointDocument() Save current local uuid into the local checkpoint document.
static void	setAutoCompact(boolean autoCompact)
void	setFilter(java.lang.String filterName, ReplicationFilter filter) Define or clear a named filter function.
static void	setFilterCompiler(ReplicationFilterCompiler filterCompiler) Registers an object that can compile source code into executable filter blocks.
protected long	setInfo(java.lang.String key, java.lang.String info)
boolean	setLastSequence(java.lang.String lastSequence, java.lang.String checkpointId)
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 void	setName(java.lang.String name) Set the database's name.
void	setValidation(java.lang.String name, Validator validator) Defines or clears a named document validation function.
protected void	setViewDocumentType(java.lang.String docType, java.lang.String viewName) Set the document type for the given view name.
protected Query	slowQuery(Mapper map) Creates a one-shot query with the given map function.
void	storageExitedTransaction(boolean committed) in CBLDatabase+Internal.m - (void) storageExitedTransaction: (BOOL)committed
java.lang.String	toString() Returns a string representation of this database.
long	totalDataSize()
RevisionList	unpushedRevisionsSince(java.lang.String sequence, ReplicationFilter filter, java.util.Map<java.lang.String,java.lang.Object> filterParams)
RevisionInternal	updateAttachment(java.lang.String filename, BlobStoreWriter body, java.lang.String contentType, AttachmentInternal.AttachmentEncoding encoding, java.lang.String docID, java.lang.String oldRevID, java.net.URL source) Updates or deletes an attachment, creating a new document revision in the process.

Methods inherited from class java.lang.Object

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

Field Detail

TAG

public static final java.lang.String TAG

See Also:

Constant Field Values

kBigAttachmentLength

public static int kBigAttachmentLength

DEFAULT_MAX_REVS

public static int DEFAULT_MAX_REVS

kCBLDatabaseLocalCheckpoint_LocalUUID

public static java.lang.String kCBLDatabaseLocalCheckpoint_LocalUUID

kLocalCheckpointDocId

public static java.lang.String kLocalCheckpointDocId

Constructor Detail

Database

public Database(java.lang.String path,
                java.lang.String name,
                Manager manager,
                boolean readOnly)

Constructor

Method Detail

getFilterCompiler

public static ReplicationFilterCompiler getFilterCompiler()

Returns the currently registered filter compiler (nil by default).

setFilterCompiler

public static void setFilterCompiler(ReplicationFilterCompiler filterCompiler)

Registers an object that can compile source code into executable filter blocks.

getAllReplications

public java.util.List<Replication> getAllReplications()

Get all the replicators associated with this database.

getDocumentCount

public int getDocumentCount()

The number of documents in the database.

getLastSequenceNumber

public long getLastSequenceNumber()

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 database. It can be used to check whether the database has changed between two points in time.

getManager

public Manager getManager()

The database manager that owns this database.

getName

public java.lang.String getName()

Get the database's name.

addChangeListener

public void addChangeListener(Database.ChangeListener listener)

Adds a Database change delegate that will be called whenever a Document within the Database changes.

compact

public void compact()
             throws CouchbaseLiteException

Compacts the database file by purging non-current JSON bodies, pruning revisions older than the maxRevTreeDepth, deleting unused attachment files, and vacuuming the SQLite database.

Throws:

CouchbaseLiteException

changeEncryptionKey

public void changeEncryptionKey(java.lang.Object newKeyOrPassword)
                         throws CouchbaseLiteException

Changes the database's encryption key, or removes encryption if the new key is null.

To use this API, the database storage engine must support encryption, and the ManagerOptions.EnableStorageEncryption property must be set to true.

Parameters:

newKeyOrPassword - The encryption key in the form of an String (a password) or an byte[] object exactly 32 bytes in length (a raw AES key.) If a string is given, it will be internally converted to a raw key using 64,000 rounds of PBKDF2 hashing. A null value is legal, and clears a previously-registered key.

Throws:

CouchbaseLiteException

createAllDocumentsQuery

public Query createAllDocumentsQuery()

Returns a query that matches all documents in the database. This is like querying an imaginary view that emits every document's ID as a key.

createDocument

public Document createDocument()

Creates a new Document object with no properties and a new (random) UUID. The document will be saved to the database when you call -createRevision: on it.

createPullReplication

public Replication createPullReplication(java.net.URL remote)

Creates a new Replication that will pull from the source Database at the given url.

Parameters:

remote - the remote URL to pull from

Returns:

A new Replication that will pull from the source Database at the given url.

createPushReplication

public Replication createPushReplication(java.net.URL remote)

Creates a new Replication that will push to the target Database at the given url.

Parameters:

remote - the remote URL to push to

Returns:

A new Replication that will push to the target Database at the given url.

delete

public void delete()
            throws CouchbaseLiteException

Deletes the database.

Throws:

CouchbaseLiteException

deleteLocalDocument

public boolean deleteLocalDocument(java.lang.String localDocID)
                            throws CouchbaseLiteException

Deletes the local document with the given ID.

Throws:

CouchbaseLiteException

getDocument

public Document getDocument(java.lang.String documentId)

Instantiates a Document object with the given ID. Doesn't touch the on-disk sqliteDb; a document with that ID doesn't even need to exist yet. CBLDocuments are cached, so there will never be more than one instance (in this sqliteDb) at a time with the same documentID. NOTE: the caching described above is not implemented yet

getExistingDocument

public Document getExistingDocument(java.lang.String docID)

Gets the Document with the given id, or null if it does not exist.

getExistingLocalDocument

public java.util.Map<java.lang.String,java.lang.Object> getExistingLocalDocument(java.lang.String documentId)

Returns the contents of the local document with the given ID, or nil if none exists.

getExistingView

public View getExistingView(java.lang.String name)

Returns the existing View with the given name, or nil if none.

getFilter

public ReplicationFilter getFilter(java.lang.String filterName)

Returns the existing filter function (block) registered with the given name. Note that filters are not persistent -- you have to re-register them on every launch.

getValidation

public Validator getValidation(java.lang.String name)

Returns the existing document validation function (block) registered with the given name. Note that validations are not persistent -- you have to re-register them on every launch.

getView

public View getView(java.lang.String name)

Returns a View object for the view with the given name. (This succeeds even if the view doesn't already exist, but the view won't be added to the database until the View is assigned a map function.)

putLocalDocument

public boolean putLocalDocument(java.lang.String localDocID,
                                java.util.Map<java.lang.String,java.lang.Object> properties)
                         throws CouchbaseLiteException

Sets the contents of the local document with the given ID. Unlike CouchDB, no revision-ID checking is done; the put always succeeds. If the properties dictionary is nil, the document will be deleted.

Throws:

CouchbaseLiteException

removeChangeListener

public void removeChangeListener(Database.ChangeListener listener)

Removes the specified delegate as a listener for the Database change event.

runAsync

public java.util.concurrent.Future runAsync(AsyncTask asyncTask)

Runs the delegate asynchronously.

runInTransaction

public boolean runInTransaction(TransactionalTask task)

Runs the block within a transaction. If the block returns NO, the transaction is rolled back. Use this when performing bulk write operations like multiple inserts/updates; it saves the overhead of multiple SQLite commits, greatly improving performance.

Does not commit the transaction if the code throws an Exception.

setFilter

public void setFilter(java.lang.String filterName,
                      ReplicationFilter filter)

Define or clear a named filter function.

Filters are used by push replications to choose which documents to send.

setValidation

public void setValidation(java.lang.String name,
                          Validator validator)

Defines or clears a named document validation function. Before any change to the database, all registered validation functions are called and given a chance to reject it. (This includes incoming changes from a pull replication.)

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.

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.

toString

public java.lang.String toString()

Returns a string representation of this database.

Overrides:

toString in class java.lang.Object

storageExitedTransaction

public void storageExitedTransaction(boolean committed)

in CBLDatabase+Internal.m - (void) storageExitedTransaction: (BOOL)committed

Specified by:

storageExitedTransaction in interface StoreDelegate

Parameters:

committed - YES on commit, NO if the transaction was aborted.

databaseStorageChanged

public void databaseStorageChanged(DocumentChange change)

in CBLDatabase+Internal.m - (void) databaseStorageChanged:(CBLDatabaseChange *)change

Specified by:

databaseStorageChanged in interface StoreDelegate

generateRevID

public java.lang.String generateRevID(byte[] json,
                                      boolean deleted,
                                      java.lang.String prevRevID)

Generates a revision ID for a new revision.

Specified by:

generateRevID in interface StoreDelegate

Parameters:

json - The canonical JSON of the revision (with metadata properties removed.)

deleted - YES if this revision is a deletion

prevRevID - The parent's revision ID, or nil if this is a new document.

getAttachmentStore

public BlobStore getAttachmentStore()

expandAttachments

public boolean expandAttachments(RevisionInternal rev,
                                 int minRevPos,
                                 boolean allowFollows,
                                 boolean decodeAttachments,
                                 Status outStatus)

Modifies a CBL_Revision's _attachments dictionary by adding the "data" property to all attachments (and removing "stub" and "follows".) GZip-encoded attachments will be unzipped unless options contains the flag kCBLLeaveAttachmentsEncoded.

Parameters:

rev - The revision to operate on. Its _attachments property may be altered.

minRevPos - Attachments with a "revpos" less than this will remain stubs.

allowFollows - If YES, non-small attachments will get a "follows" key instead of data.

decodeAttachments - If YES, attachments with "encoding" properties will be decoded.

outStatus - On failure, will be set to the error status.

Returns:

YES on success, NO on failure.

runFilter

public boolean runFilter(ReplicationFilter filter,
                         java.util.Map<java.lang.String,java.lang.Object> filterParams,
                         RevisionInternal rev)

Specified by:

runFilter in interface StoreDelegate

setAutoCompact

public static void setAutoCompact(boolean autoCompact)

addDatabaseListener

public void addDatabaseListener(Database.DatabaseListener listener)

removeDatabaseListener

public void removeDatabaseListener(Database.DatabaseListener listener)

exists

public boolean exists()

open

public void open()
          throws CouchbaseLiteException

Throws:

CouchbaseLiteException

open

public void open(DatabaseOptions options)
          throws CouchbaseLiteException

Throws:

CouchbaseLiteException

close

public boolean close()

getAttachmentWriter

public BlobStoreWriter getAttachmentWriter()

totalDataSize

public long totalDataSize()

privateUUID

public java.lang.String privateUUID()

publicUUID

public java.lang.String publicUUID()

getDocument

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

getDocument

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

loadRevisionBody

public RevisionInternal loadRevisionBody(RevisionInternal rev)
                                  throws CouchbaseLiteException

Throws:

CouchbaseLiteException

getPossibleAncestorRevisionIDs

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

NOTE: This method is internal use only (from BulkDownloader and PullerInternal)

getRevisionHistoryDictStartingFromAnyAncestor

public java.util.Map<java.lang.String,java.lang.Object> getRevisionHistoryDictStartingFromAnyAncestor(RevisionInternal rev,
                                                                                                      java.util.List<java.lang.String> ancestorRevIDs)

Returns the revision history as a _revisions dictionary, as returned by the REST API's ?revs=true option.

changesSince

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

unpushedRevisionsSince

public RevisionList unpushedRevisionsSince(java.lang.String sequence,
                                           ReplicationFilter filter,
                                           java.util.Map<java.lang.String,java.lang.Object> filterParams)

getAllDocs

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

Throws:

CouchbaseLiteException

getAttachment

public AttachmentInternal getAttachment(java.util.Map info,
                                        java.lang.String filename)
                                 throws CouchbaseLiteException

Throws:

CouchbaseLiteException

fileForAttachmentDict

public java.net.URL fileForAttachmentDict(java.util.Map<java.lang.String,java.lang.Object> attachmentDict)

inlineFollowingAttachmentsIn

public boolean inlineFollowingAttachmentsIn(RevisionInternal rev)

updateAttachment

public RevisionInternal updateAttachment(java.lang.String filename,
                                         BlobStoreWriter body,
                                         java.lang.String contentType,
                                         AttachmentInternal.AttachmentEncoding encoding,
                                         java.lang.String docID,
                                         java.lang.String oldRevID,
                                         java.net.URL source)
                                  throws CouchbaseLiteException

Updates or deletes an attachment, creating a new document revision in the process. Used by the PUT / DELETE methods called on attachment URLs.

Throws:

CouchbaseLiteException

rememberAttachmentWritersForDigests

public void rememberAttachmentWritersForDigests(java.util.Map<java.lang.String,BlobStoreWriter> blobsByDigest)

rememberPendingKey

public void rememberPendingKey(BlobKey key,
                               java.lang.String digest)

parseCouchDBRevisionHistory

public static java.util.List<java.lang.String> parseCouchDBRevisionHistory(java.util.Map<java.lang.String,java.lang.Object> docProperties)

Parses the _revisions dict from a document into an array of revision ID strings

putRevision

public RevisionInternal putRevision(RevisionInternal rev,
                                    java.lang.String prevRevId,
                                    boolean allowConflict)
                             throws CouchbaseLiteException

Throws:

CouchbaseLiteException

putRevision

public RevisionInternal putRevision(RevisionInternal putRev,
                                    java.lang.String inPrevRevID,
                                    boolean allowConflict,
                                    Status outStatus)
                             throws CouchbaseLiteException

Throws:

CouchbaseLiteException

put

public RevisionInternal put(java.lang.String docID,
                            java.util.Map<java.lang.String,java.lang.Object> properties,
                            java.lang.String prevRevID,
                            boolean allowConflict,
                            java.net.URL source,
                            Status outStatus)
                     throws CouchbaseLiteException

Throws:

CouchbaseLiteException

forceInsert

public void forceInsert(RevisionInternal inRev,
                        java.util.List<java.lang.String> history,
                        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.

Throws:

CouchbaseLiteException

lastSequenceWithCheckpointId

public java.lang.String lastSequenceWithCheckpointId(java.lang.String checkpointId)

setLastSequence

public boolean setLastSequence(java.lang.String lastSequence,
                               java.lang.String checkpointId)

findMissingRevisions

public int findMissingRevisions(RevisionList touchRevs)
                         throws SQLException

Throws:

SQLException

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 database _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

Parameters:

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

getLocalDocument

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

getStartTime

public long getStartTime()

isOpen

public boolean isOpen()

Is the database open?

addActiveReplication

public void addActiveReplication(Replication replication)

getPersistentCookieStore

public PersistentCookieJar getPersistentCookieStore()

Get the PersistentCookieStore associated with this database. Will lazily create one if none exists.

clearDocumentCache

protected void clearDocumentCache()

Empties the cache of recently used Document objects. API calls will now instantiate and return new instances.

getCachedDocument

protected Document getCachedDocument(java.lang.String documentID)

Returns the already-instantiated cached Document with the given ID, or nil if none is yet cached.

removeDocumentFromCache

protected void removeDocumentFromCache(Document document)

getAttachmentStorePath

protected java.lang.String getAttachmentStorePath()

getPath

protected java.lang.String getPath()

getStore

protected Store getStore()

getViewStorage

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

Throws:

CouchbaseLiteException

setInfo

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

getInfo

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

expirationOfDocument

protected long expirationOfDocument(java.lang.String docID)

getAllRevisions

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

findCommonAncestorOf

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

putLocalRevision

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

Throws:

CouchbaseLiteException

getRevisionHistory

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

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

setViewDocumentType

protected void setViewDocumentType(java.lang.String docType,
                                   java.lang.String viewName)

Set the document type for the given view name.

Parameters:

docType - document type

viewName - view name

getViewDocumentType

protected java.lang.String getViewDocumentType(java.lang.String viewName)

Get the document type for the given view name.

Parameters:

viewName - view name

Returns:

document type if available, otherwise returns null.

forgetView

protected void forgetView(java.lang.String name)

in CBLDatabase+Internal.m - (void) forgetViewNamed: (NSString*)name

queryViewNamed

protected java.util.List<QueryRow> queryViewNamed(java.lang.String viewName,
                                                  QueryOptions options,
                                                  java.util.List<java.lang.Long> outLastSequence)
                                           throws CouchbaseLiteException

Reference: In CBLQuery.m - (CBLQueryEnumerator*) queryViewNamed: (NSString*)viewName options: (CBLQueryOptions*)options ifChangedSince: (SequenceNumber)ifChangedSince status: (CBLStatus*)outStatus

Throws:

CouchbaseLiteException

makeAnonymousView

protected View makeAnonymousView()

getAllViews

protected java.util.List<View> getAllViews()

NOTE: Only used by Unit Tests

getAttachments

protected java.util.Map<java.lang.String,java.lang.Object> getAttachments(java.lang.String docID,
                                                                          java.lang.String revID)

- (NSDictionary*) attachmentsForDocID: (NSString*)docID revID: (NSString*)revID status: (CBLStatus*)outStatus

getAttachment

public AttachmentInternal getAttachment(RevisionInternal rev,
                                        java.lang.String filename)
                                 throws CouchbaseLiteException

Throws:

CouchbaseLiteException

rememberAttachmentWriter

protected void rememberAttachmentWriter(BlobStoreWriter writer)

rememberAttachmentWriter

protected void rememberAttachmentWriter(BlobStoreWriter writer,
                                        java.lang.String digest)

findActiveReplicator

protected Replication findActiveReplicator(Replication replicator)

slowQuery

protected Query slowQuery(Mapper map)

Creates a one-shot query with the given map function. This is equivalent to creating an anonymous View and then deleting it immediately after querying it. It may be useful during development, but in general this is inefficient if this map will be used more than once, because the entire view has to be regenerated from scratch every time.

getParentRevision

protected RevisionInternal getParentRevision(RevisionInternal rev)

replaceUUIDs

protected boolean replaceUUIDs()

setName

protected void setName(java.lang.String name)

Set the database's name.

saveLocalUUIDInLocalCheckpointDocument

protected boolean saveLocalUUIDInLocalCheckpointDocument()

Save current local uuid into the local checkpoint document.

This method is called only when importing or replacing the database. The old localUUID is used by replicators to get the local checkpoint from the imported database in order to start replicating from from the current local checkpoint of the imported database after importing.

in CBLDatabase+Replication.m - (BOOL) saveLocalUUIDInLocalCheckpointDocument: (NSError**)outError;

putLocalCheckpointDocumentWithKey

protected boolean putLocalCheckpointDocumentWithKey(java.lang.String key,
                                                    java.lang.Object value)

Put a property with a given key and value into the local checkpoint document.

in CBLDatabase+Replication.m - (BOOL) putLocalCheckpointDocumentWithKey: (NSString*)key value:(id)value outError: (NSError**)outError

getLocalCheckpointDocumentPropertyValueForKey

protected java.lang.Object getLocalCheckpointDocumentPropertyValueForKey(java.lang.String key)

Returns a property value specifiec by the key from the local checkpoint document.

getLocalCheckpointDocument

protected java.util.Map<java.lang.String,java.lang.Object> getLocalCheckpointDocument()

Returns local checkpoint document if it exists. Otherwise returns nil.