com.couchbase.lite.internal.core

Class C4Database

java.lang.Object

java.lang.Number

java.util.concurrent.atomic.AtomicLong

com.couchbase.lite.internal.core.C4NativePeer

com.couchbase.lite.internal.core.C4Database

All Implemented Interfaces:

Serializable

public class C4Database
extends C4NativePeer

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
C4Database(long handle)
C4Database(String path, int flags, String storageEngine, int versioning, int algorithm, byte[] encryptionKey)

Method Summary

Modifier and Type	Method and Description
void	beginTransaction()
void	close()
void	compact()
static void	copyDb(String sourcePath, String destinationPath, int flags, String storageEngine, int versioning, int algorithm, byte[] encryptionKey)
C4Document	create(String docID, byte[] body, int revisionFlags)
C4Document	create(String docID, FLSliceResult body, int flags)
C4DatabaseObserver	createDatabaseObserver(C4DatabaseObserverListener listener, Object context)
C4DocumentObserver	createDocumentObserver(String docID, C4DocumentObserverListener listener, Object context)
boolean	createIndex(String name, String expressionsJSON, int indexType, String language, boolean ignoreDiacritics)
C4Replicator	createLocalReplicator(C4Database otherLocalDB, int push, int pull, byte[] options, C4ReplicatorListener listener, C4ReplicationFilter pushFilter, C4ReplicationFilter pullFilter, AbstractReplicator replicatorContext)
C4Query	createQuery(String expression)
C4Replicator	createRemoteReplicator(String scheme, String host, int port, String path, String remoteDatabaseName, int push, int pull, byte[] options, C4ReplicatorListener listener, C4ReplicationFilter pushFilter, C4ReplicationFilter pullFilter, AbstractReplicator replicatorContext, SocketFactory socketFactoryContext, int framing)
C4Replicator	createTargetReplicator(C4Socket openSocket, int push, int pull, byte[] options, C4ReplicatorListener listener, Object replicatorContext)
void	delete()
static void	deleteDbAtPath(String path)
void	deleteIndex(String name)
FLSliceResult	encodeJSON(byte[] jsonData)
void	endTransaction(boolean commit)
C4DocEnumerator	enumerateAllDocs(int flags)
C4DocEnumerator	enumerateChanges(long since, int flags)
void	free()
C4Document	get(String docID)
C4Document	get(String docID, boolean mustExist)
C4BlobStore	getBlobStore()
C4Document	getBySequence(long sequence)
String	getCookies(URI uri)
long	getDocumentCount()
long	getExpiration(String docID)
FLSharedKeys	getFLSharedKeys()
FLValue	getIndexes()
long	getLastSequence()
int	getMaxRevTreeDepth()
String	getPath()
byte[]	getPrivateUUID()
byte[]	getPublicUUID()
FLEncoder	getSharedFleeceEncoder()
long	nextDocExpiration()
boolean	performMaintenance(MaintenanceType type)
void	purgeDoc(String docID)
long	purgeExpiredDocs()
C4Document	put(byte[] body, String docID, int revFlags, boolean existingRevision, boolean allowConflict, String[] history, boolean save, int maxRevTreeDepth, int remoteDBID)
C4Document	put(FLSliceResult body, String docID, int revFlags, boolean existingRevision, boolean allowConflict, String[] history, boolean save, int maxRevTreeDepth, int remoteDBID)
static void	rawFreeDocument(long rawDoc)
C4RawDocument	rawGet(String storeName, String docID)
void	rawPut(String storeName, String key, String meta, byte[] body)
void	rekey(int keyType, byte[] newKey)
void	setCookie(URI uri, String setCookieHeader)
void	setExpiration(String docID, long timestamp)
void	setMaxRevTreeDepth(int maxRevTreeDepth)

Methods inherited from class java.util.concurrent.atomic.AtomicLong

accumulateAndGet, addAndGet, compareAndSet, decrementAndGet, doubleValue, floatValue, get, getAndAccumulate, getAndAdd, getAndDecrement, getAndIncrement, getAndSet, getAndUpdate, incrementAndGet, intValue, lazySet, longValue, set, toString, updateAndGet, weakCompareAndSet

Methods inherited from class java.lang.Number

byteValue, shortValue

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

C4Database

public C4Database(String path,
                  int flags,
                  String storageEngine,
                  int versioning,
                  int algorithm,
                  byte[] encryptionKey)
           throws LiteCoreException

Throws:

LiteCoreException

C4Database

public C4Database(long handle)

Method Detail

copyDb

public static void copyDb(String sourcePath,
                          String destinationPath,
                          int flags,
                          String storageEngine,
                          int versioning,
                          int algorithm,
                          byte[] encryptionKey)
                   throws LiteCoreException

Throws:

LiteCoreException

rawFreeDocument

public static void rawFreeDocument(long rawDoc)
                            throws LiteCoreException

Throws:

LiteCoreException

deleteDbAtPath

public static void deleteDbAtPath(String path)
                           throws LiteCoreException

Throws:

LiteCoreException

free

public void free()

close

public void close()
           throws LiteCoreException

Throws:

LiteCoreException

delete

public void delete()
            throws LiteCoreException

Throws:

LiteCoreException

rekey

public void rekey(int keyType,
                  byte[] newKey)
           throws LiteCoreException

Throws:

LiteCoreException

getPath

@Nullable
public String getPath()

getDocumentCount

public long getDocumentCount()

getLastSequence

public long getLastSequence()

nextDocExpiration

public long nextDocExpiration()

purgeExpiredDocs

public long purgeExpiredDocs()

purgeDoc

public void purgeDoc(String docID)
              throws LiteCoreException

Throws:

LiteCoreException

getMaxRevTreeDepth

public int getMaxRevTreeDepth()

setMaxRevTreeDepth

public void setMaxRevTreeDepth(int maxRevTreeDepth)

getPublicUUID

public byte[] getPublicUUID()
                     throws LiteCoreException

Throws:

LiteCoreException

getPrivateUUID

public byte[] getPrivateUUID()
                      throws LiteCoreException

Throws:

LiteCoreException

compact

public void compact()
             throws LiteCoreException

Throws:

LiteCoreException

beginTransaction

public void beginTransaction()
                      throws LiteCoreException

Throws:

LiteCoreException

endTransaction

public void endTransaction(boolean commit)
                    throws LiteCoreException

Throws:

LiteCoreException

rawGet

public C4RawDocument rawGet(String storeName,
                            String docID)
                     throws LiteCoreException

Throws:

LiteCoreException

rawPut

public void rawPut(String storeName,
                   String key,
                   String meta,
                   byte[] body)
            throws LiteCoreException

Throws:

LiteCoreException

getSharedFleeceEncoder

public FLEncoder getSharedFleeceEncoder()

encodeJSON

public FLSliceResult encodeJSON(byte[] jsonData)
                         throws LiteCoreException

Throws:

LiteCoreException

getFLSharedKeys

public final FLSharedKeys getFLSharedKeys()

enumerateChanges

public C4DocEnumerator enumerateChanges(long since,
                                        int flags)
                                 throws LiteCoreException

Throws:

LiteCoreException

enumerateAllDocs

public C4DocEnumerator enumerateAllDocs(int flags)
                                 throws LiteCoreException

Throws:

LiteCoreException

get

public C4Document get(String docID)
               throws LiteCoreException

Throws:

LiteCoreException

get

public C4Document get(String docID,
                      boolean mustExist)
               throws LiteCoreException

Throws:

LiteCoreException

getBySequence

public C4Document getBySequence(long sequence)
                         throws LiteCoreException

Throws:

LiteCoreException

setExpiration

public void setExpiration(String docID,
                          long timestamp)
                   throws LiteCoreException

Throws:

LiteCoreException

getExpiration

public long getExpiration(String docID)
                   throws LiteCoreException

Throws:

LiteCoreException

put

public C4Document put(byte[] body,
                      String docID,
                      int revFlags,
                      boolean existingRevision,
                      boolean allowConflict,
                      String[] history,
                      boolean save,
                      int maxRevTreeDepth,
                      int remoteDBID)
               throws LiteCoreException

Throws:

LiteCoreException

put

public C4Document put(FLSliceResult body,
                      String docID,
                      int revFlags,
                      boolean existingRevision,
                      boolean allowConflict,
                      String[] history,
                      boolean save,
                      int maxRevTreeDepth,
                      int remoteDBID)
               throws LiteCoreException

Throws:

LiteCoreException

create

@NonNull
public C4Document create(String docID,
                                  byte[] body,
                                  int revisionFlags)
                           throws LiteCoreException

Throws:

LiteCoreException

create

@NonNull
public C4Document create(String docID,
                                  FLSliceResult body,
                                  int flags)
                           throws LiteCoreException

Throws:

LiteCoreException

createDatabaseObserver

@NonNull
public C4DatabaseObserver createDatabaseObserver(C4DatabaseObserverListener listener,
                                                          Object context)

createDocumentObserver

@NonNull
public C4DocumentObserver createDocumentObserver(String docID,
                                                          C4DocumentObserverListener listener,
                                                          Object context)

getBlobStore

@NonNull
public C4BlobStore getBlobStore()
                                  throws LiteCoreException

Throws:

LiteCoreException

createQuery

public C4Query createQuery(String expression)
                    throws LiteCoreException

Throws:

LiteCoreException

createIndex

public boolean createIndex(String name,
                           String expressionsJSON,
                           int indexType,
                           String language,
                           boolean ignoreDiacritics)
                    throws LiteCoreException

Throws:

LiteCoreException

deleteIndex

public void deleteIndex(String name)
                 throws LiteCoreException

Throws:

LiteCoreException

getIndexes

public FLValue getIndexes()
                   throws LiteCoreException

Throws:

LiteCoreException

performMaintenance

public boolean performMaintenance(MaintenanceType type)
                           throws LiteCoreException

Throws:

LiteCoreException

createRemoteReplicator

@NonNull
public C4Replicator createRemoteReplicator(@Nullable
                                                    String scheme,
                                                    @Nullable
                                                    String host,
                                                    int port,
                                                    @Nullable
                                                    String path,
                                                    @Nullable
                                                    String remoteDatabaseName,
                                                    int push,
                                                    int pull,
                                                    @NonNull
                                                    byte[] options,
                                                    @Nullable
                                                    C4ReplicatorListener listener,
                                                    @Nullable
                                                    C4ReplicationFilter pushFilter,
                                                    @Nullable
                                                    C4ReplicationFilter pullFilter,
                                                    @NonNull
                                                    AbstractReplicator replicatorContext,
                                                    @Nullable
                                                    SocketFactory socketFactoryContext,
                                                    int framing)
                                             throws LiteCoreException

Throws:

LiteCoreException

createLocalReplicator

@NonNull
public C4Replicator createLocalReplicator(@NonNull
                                                   C4Database otherLocalDB,
                                                   int push,
                                                   int pull,
                                                   @NonNull
                                                   byte[] options,
                                                   @Nullable
                                                   C4ReplicatorListener listener,
                                                   @Nullable
                                                   C4ReplicationFilter pushFilter,
                                                   @Nullable
                                                   C4ReplicationFilter pullFilter,
                                                   @NonNull
                                                   AbstractReplicator replicatorContext)
                                            throws LiteCoreException

Throws:

LiteCoreException

createTargetReplicator

public C4Replicator createTargetReplicator(@NonNull
                                           C4Socket openSocket,
                                           int push,
                                           int pull,
                                           @Nullable
                                           byte[] options,
                                           @Nullable
                                           C4ReplicatorListener listener,
                                           @NonNull
                                           Object replicatorContext)
                                    throws LiteCoreException

Throws:

LiteCoreException

setCookie

public void setCookie(@NonNull
                      URI uri,
                      @NonNull
                      String setCookieHeader)
               throws LiteCoreException

Throws:

LiteCoreException

getCookies

@Nullable
public String getCookies(@NonNull
                                   URI uri)
                            throws LiteCoreException

Throws:

LiteCoreException