QueryRow

QueryRow

A result row for a Couchbase Lite View Query.

Syntax


@interface CBLQueryRow : NSObject
class CBLQueryRow : NSObject
public class QueryRow
public class QueryRow
public class QueryRow

Summary


Properties
Revision[]
Gets the conflicting Revisions of the associated Document. The first Revision in the array will be the default 'winning' Revision that shadows the Revisions. This is only valid in an all-documents Query whose allDocsMode is set to ShowConflicts or OnlyConflicts, otherwise it returns null.
Database
database { get; }
Gets the Database that owns the QueryRow's View.
Document
document { get; }
Gets the associated Document.
String
documentId { get; }
Gets the Id of the associated Document.
Map<String, Object>
Gets the properties of the associated Document.
String
Gets the Id of the associated Revision.
Object
key { get; }
Gets the QueryRow's key.
long
sequenceNumber { get; }
Gets the sequence number of the associated Revision.
String
sourceDocumentId { get; }
Gets the Id of the Document that caused the QueryRow to be emitted into the View. This will be the same as the documentId property, unless the map function caused a related Document to be linked by adding an '_id' key to the emmitted value. In this case, documentId will refer to the linked Document, while sourceDocumentId always refers to the original Document. In a reduced or grouped Query, sourceDocumentId will be null because the rows don't correspond to individual Documents.
Object
value { get; }
Gets the QueryRow's value.

Properties


Revision[] conflictingRevisions { get; }
Gets the conflicting Revisions of the associated Document. The first Revision in the array will be the default 'winning' Revision that shadows the Revisions. This is only valid in an all-documents Query whose allDocsMode is set to ShowConflicts or OnlyConflicts, otherwise it returns null.

Syntax

@property (readonly) NSArray * conflictingRevisions
var conflictingRevisions: [AnyObject]! { get }
public List<Revision> getConflictingRevisions()
public List<Revision> getConflictingRevisions()
public IEnumerable<Revision> ConflictingRevisions { get; }
Database database { get; }
Gets the Database that owns the QueryRow's View.

Syntax

@property (readonly) CBLDatabase * database
var database: CBLDatabase! { get }
public Database getDatabase()
public Database getDatabase()
public Database Database { get; }
Document document { get; }
Gets the associated Document.

Syntax

@property (readonly) CBLDocument * document
var document: CBLDocument! { get }
public Document getDocument()
public Document getDocument()
public Document Document { get; }
String documentId { get; }
Gets the Id of the associated Document.

Syntax

@property (readonly) NSString * documentID
var documentID: String! { get }
public String getDocumentId()
public String getDocumentId()
public String DocumentId { get; }
Map<String, Object> documentProperties { get; }
Gets the properties of the associated Document.

Syntax

@property (readonly) NSDictionary * documentProperties
var documentProperties: [NSObject : AnyObject]! { get }
public Map<String, Object> getDocumentProperties()
public Map<String, Object> getDocumentProperties()
public Dictionary<String, Object> DocumentProperties { get; }
String documentRevisionId { get; }
Gets the Id of the associated Revision.

Syntax

@property (readonly) NSString * documentRevisionID
var documentRevisionID: String! { get }
public String getDocumentRevisionId()
public String getDocumentRevisionId()
public String DocumentRevisionId { get; }
Object key { get; }
Gets the QueryRow's key.

Syntax

@property (readonly) id key
var key: AnyObject! { get }
public Object getKey()
public Object getKey()
public Object Key { get; }
long sequenceNumber { get; }
Gets the sequence number of the associated Revision.

Syntax

@property (readonly) UInt64 sequenceNumber
var sequenceNumber: Int64 { get }
public long getSequenceNumber()
public long getSequenceNumber()
public long SequenceNumber { get; }
String sourceDocumentId { get; }
Gets the Id of the Document that caused the QueryRow to be emitted into the View. This will be the same as the documentId property, unless the map function caused a related Document to be linked by adding an '_id' key to the emmitted value. In this case, documentId will refer to the linked Document, while sourceDocumentId always refers to the original Document. In a reduced or grouped Query, sourceDocumentId will be null because the rows don't correspond to individual Documents.

Syntax

@property (readonly) NSString * sourceDocumentID
var sourceDocumentID: String! { get }
public String getSourceDocumentID()
public String getSourceDocumentID()
public String SourceDocumentID { get; }
Object value { get; }
Gets the QueryRow's value.

Syntax

@property (readonly) id value
var value: AnyObject! { get }
public Object getValue()
public Object getValue()
public Object Value { get; }