Classes
The following classes are available globally.
-
Declaration
Swift
public final class Message
-
Declaration
Swift
public class MessageEndpoint : IEndpoint
-
Declaration
Swift
public class MessageEndpointListenerConfiguration
-
Declaration
Swift
public class MessageEndpointListener
-
Array expression.
See moreDeclaration
Swift
public final class ArrayExpression
-
The In class represents the IN clause object in a quantified operator (ANY/ANY AND EVERY/EVERY
See moreIN SATISFIES ). The IN clause is used for specifying an array object or an expression evaluated as an array object, each item of which will be evaluated against the satisfies expression. Declaration
Swift
public final class ArrayExpressionIn
-
The Satisfies class represents the SATISFIES clause object in a quantified operator (ANY/ANY AND EVERY/EVERY
See moreIN SATISFIES ). The SATISFIES clause is used for specifying an expression that will be used to evaluate each item in the array. Declaration
Swift
public final class ArrayExpressionSatisfies
-
Array function factory.
See moreDeclaration
Swift
public final class ArrayFunction
-
ArrayObject provides readonly access to array data.
See moreDeclaration
Swift
public class ArrayObject : ArrayProtocol, Equatable, Hashable, Sequence
-
Blob contains arbitrary binary data, tagged with a MIME type. Blobs can be arbitrarily large, and their data is loaded only on demand (when the
See morecontent
orcontentStream
properties are accessed), not when the document is loaded. The document’s raw JSON form only contains the Blob’s metadata (type, length and a digest of the data) in a small object. The data itself is stored externally to the document, keyed by the digest.Declaration
Swift
public final class Blob : Equatable, Hashable
-
Collation factory. CouchbaseLite provides two types of the Collation, ASCII and Unicode. Without specifying the COLLATE expression. Couchbase Lite will use the ASCII with case sensitive collation by default.
See moreDeclaration
Swift
public final class Collation
-
ConflictResolver provides access to the default conflict resolver used by the replicator
See moreDeclaration
Swift
public final class ConflictResolver
-
Undocumented
See moreDeclaration
Swift
public class ConsoleLogger
-
ENTERPRISE EDITION ONLY : UNCOMMITTED
CoreMLPredictiveModel is a Core ML based implementation of the PredictiveModel protocol. Basically the CoreMLPredictiveModel used a Core ML model to return prediction results.
CoreMLPredictiveModel automatically converts between Couchbase Lite data and Core ML data when calling into the MLModel object to return prediction results. All Core ML data types including Int64, Double, String, Dictionary, MultiArray, Image, and Sequence are supported.
When the MLObject has a single input and the input type is Image, CoreMLPredictiveModel will use Vision framework via the VNCoreMLModel to process the input image and call into the MLModel object. The CoreMLPredictiveModel supports all VNObservation types including VNClassificationObservation, VNCoreMLFeatureValueObservation, and VNPixelBufferObservation as mentioned in https://developer.apple.com/documentation/vision/vncoremlrequest. However there is a compatibility limitation when the VNCoreMLModel returns VNCoreMLFeatureValueObservation or VNPixelBufferObservation results that the MLModel must return a single output, otherwise the observation outputs cannot be mapped to the MLModel outputs. When the VNCoreMLModel cannot be used to result the prediction result, CoreMLPredictiveModel will fall back to use the MLModel instead.
When converting blob data to VNPixelBuffer for an input image, only ARGB pixel format is currently supported. However this limitation is applied only when the VNCoreMLModel cannot be used.
See moreDeclaration
Swift
@available(OSX 10.13, iOS 11.0, *) open class CoreMLPredictiveModel : PredictiveModel
-
A query data source factory. The current data source supported is the database.
See moreDeclaration
Swift
public final class DataSource
-
Configuration for opening a database.
See moreDeclaration
Swift
public class DatabaseConfiguration
-
DictionaryObject provides readonly access to dictionary data.
See moreDeclaration
Swift
public class DictionaryObject : DictionaryProtocol, Equatable, Hashable, Sequence
-
Couchbase Lite document. The Document is immutable.
See moreDeclaration
Swift
public class Document : DictionaryProtocol, Equatable, Hashable, Sequence
-
DocumentFragment provides access to a document object. DocumentFragment also provides subscript access by either key or index to the data values of the document which are wrapped by Fragment objects.
See moreDeclaration
Swift
public final class DocumentFragment : DictionaryFragment
-
Query expression factory.
See moreDeclaration
Swift
public final class Expression
-
File logger used for writing log messages to files. To enable the file logger, setup the log file configuration and specify the log level as desired.
It is important to configure your LogFileConfiguration object appropriately before setting to a logger. Logger make a copy of the configuration settings you provide and use those settings to configure the logger. Once configured, the logger object ignores any changes you make to the LogFileConfiguration object.
See moreDeclaration
Swift
public class FileLogger
-
Fragment provides readonly access to data value. Fragment also provides subscript access by either key or index to the nested values which are wrapped by Fragment objects.
See moreDeclaration
Swift
public class Fragment : FragmentProtocol, ArrayFragment, DictionaryFragment
-
Full-text expression factory.
See moreDeclaration
Swift
public final class FullTextExpression
-
Full-text function factory.
See moreDeclaration
Swift
public final class FullTextFunction
-
Full-text search index item.
See moreDeclaration
Swift
public class FullTextIndexItem
-
IndexBuilder used for building database index objects.
See moreDeclaration
Swift
public class IndexBuilder
-
A Limit component represents the LIMIT clause of the query statement.
Declaration
Swift
public final class Limit : Query
-
Listener token returned when adding a change listener. The token is used for removing the added change listener.
Declaration
Swift
public class ListenerToken
-
Log allows to configure console and file logger or to set a custom logger.
See moreDeclaration
Swift
public class Log
-
Log file configuration.
See moreDeclaration
Swift
public class LogFileConfiguration
-
Meta is a factory class for creating the meta expressions that refer to the metadata properties of the document.
See moreDeclaration
Swift
public final class Meta
-
MutableArrayObject provides access to array data.
See moreDeclaration
Swift
public final class MutableArrayObject : ArrayObject, MutableArrayProtocol
-
MutableDictionaryObject provides access to dictionary data.
See moreDeclaration
Swift
public final class MutableDictionaryObject : DictionaryObject, MutableDictionaryProtocol
-
A mutable version of the Document.
See moreDeclaration
Swift
public final class MutableDocument : Document, MutableDictionaryProtocol
-
MutableFragment provides read and write access to data value. MutableFragment also provides subscript access by either key or index to the nested values which are wrapped by MutableFragment objects.
See moreDeclaration
Swift
public final class MutableFragment : Fragment, MutableDictionaryFragment, MutableArrayFragment
-
Query parameters used for setting values to the query parameters defined in the query.
See moreDeclaration
Swift
public class Parameters
-
ENTERPRISE EDITION ONLY : UNCOMMITTED
Predictive model manager class for registering and unregistering predictive models.
See moreDeclaration
Swift
public class Prediction
-
ENTERPRISE EDITION ONLY : UNCOMMITTED
The predictive index used for querying with prediction function. The predictive index is different from the normal index in that the predictive index will cache the prediction result along with creating the value index of the prediction output properties.
The PredictiveIndex can be created by using IndexBuilder’s predictiveIndex() function. If the prediction output properties are not specified, the predictive index will only cache the predictive result so that the predictive model will not be called again after indexing.
Declaration
Swift
public final class PredictiveIndex : Index, CBLIndexConvertible
-
A replicator for replicating document changes between a local database and a target database. The replicator can be bidirectional or either push or pull. The replicator can also be one-short or continuous. The replicator runs asynchronously, so observe the status property to be notified of progress.
See moreDeclaration
Swift
public final class Replicator
-
Replicator configuration.
See moreDeclaration
Swift
public class ReplicatorConfiguration
-
Result represents a single row in the query result. The projecting result value can be accessed either by using a zero based index or by a key corresponding to the SelectResult objects given when constructing the Query object.
A key used for accessing the projecting result value could be one of the followings:
- The alias name of the SelectResult object.
- The last component of the keypath or property name of the property expression used when creating the SelectResult object.
- The provision key in $1, $2, …$N format for the SelectResult that doesn’t have an alias name specified or is not a property expression such as an aggregate function expression (e.g. count(), avg(), min(), max(), sum() and etc). The number suffix after the ‘$’ character is a running number starting from one.
Declaration
Swift
public final class Result : ArrayProtocol, DictionaryProtocol, Sequence
-
ResultSet is a result returned from a query.
See moreDeclaration
Swift
public final class ResultSet : Sequence, IteratorProtocol
-
SelectResult factory.
See moreDeclaration
Swift
public final class SelectResult