CollectionReference<T extends Object?> class
Represents a reference to a collection of documents.
Parameters:
helper: The query helper.- oracledb: The FusabaseOracledb instance.
- path: The path to the collection.
parent_: Optional parent reference.
Returns: An instance of CollectionReference.
Example:
var collection = oracledb.collection('users');
- Inheritance
- Implementers
Constructors
- CollectionReference({required QueryHelper helper, required FusabaseOracledb oracledb, required String path, dynamic parent_})
Properties
- fromConverter ↔ dynamic
-
getter/setter pairinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- id → String
-
Gets the ID of the collection.
no setter
- oracledb → FusabaseOracledb
-
Gets the FusabaseOracledb instance associated with this query.
no setterinherited
-
parameters
→ Map<
String, dynamic> -
Gets the parameters of the query.
no setterinherited
-
parent
→ DocumentReference<
T> ? -
Gets the parent document reference, if any.
no setter
- path → String
-
Gets the path of the query.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- toConverter ↔ dynamic
-
getter/setter pairinherited
- type ↔ String
-
getter/setter pairinherited
Methods
-
add(
T data) → Future< DocumentReference< T> > - Adds a new document to the collection with the given data.
-
aggregate(
AggregateField aggregateField1, [AggregateField? aggregateField2, AggregateField? aggregateField3, AggregateField? aggregateField4, AggregateField? aggregateField5, AggregateField? aggregateField6, AggregateField? aggregateField7, AggregateField? aggregateField8, AggregateField? aggregateField9, AggregateField? aggregateField10, AggregateField? aggregateField11, AggregateField? aggregateField12, AggregateField? aggregateField13, AggregateField? aggregateField14, AggregateField? aggregateField15, AggregateField? aggregateField16, AggregateField? aggregateField17, AggregateField? aggregateField18, AggregateField? aggregateField19, AggregateField? aggregateField20, AggregateField? aggregateField21, AggregateField? aggregateField22, AggregateField? aggregateField23, AggregateField? aggregateField24, AggregateField? aggregateField25, AggregateField? aggregateField26, AggregateField? aggregateField27, AggregateField? aggregateField28, AggregateField? aggregateField29, AggregateField? aggregateField30]) → AggregateQuery -
Creates an aggregation query with the specified fields.
inherited
-
column(
List< String> values) → dynamic -
Applies column selection to the query.
inherited
-
count(
) → AggregateQuery -
Creates a count aggregation query.
inherited
-
doc(
[String? path]) → DocumentReference< T> - Gets a DocumentReference for the document at the specified path.
-
endAt(
Iterable< Object?> values) → Query<T> -
Ends the query results at the provided set of values.
inherited
-
endAtDocument(
DocumentSnapshot< Object?> documentSnapshot) → Query<T> -
Ends the query results at the document.
inherited
-
endBefore(
Iterable< Object?> values) → Query<T> -
Ends the query results before the provided set of values.
inherited
-
endBeforeDocument(
DocumentSnapshot< Object?> documentSnapshot) → Query<T> -
Ends the query results before the document.
inherited
-
findNearest(
String field, Map< String, dynamic> query, {String? metric, int? topK, num? threshold}) → Query<T> -
Creates a v2 vector similarity query.
inherited
-
get(
[GetOptions? options]) → Future< QuerySnapshot< T> > -
Fetches the documents matching the query.
inherited
-
limit(
int number) → Query< T> -
Limits the number of documents returned.
inherited
-
limitToLast(
int limit) → Query< T> -
Limits the query to the last
limitdocuments.inherited -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
orderBy(
Object field, {bool descending = false}) → Query< T> -
Orders the query results by a field.
inherited
-
snapshots(
{bool includeMetadataChanges = false, ListenSource source = ListenSource.defaultSource}) → Stream< QuerySnapshot< T> > -
Returns a stream of snapshots for the query.
inherited
-
startAfter(
Iterable< Object?> values) → Query<T> -
Starts the query results after the provided set of values.
inherited
-
startAfterDocument(
DocumentSnapshot< Object?> documentSnapshot) → Query<T> -
Starts the query results after the document.
inherited
-
startAt(
Iterable< Object?> values) → Query<T> -
Starts the query results at the provided set of values.
inherited
-
startAtDocument(
DocumentSnapshot< Object?> documentSnapshot) → Query<T> -
Starts the query results at the document.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
-
where(
Object field, {Object? isEqualTo, Object? isNotEqualTo, Object? isLessThan, Object? isLessThanOrEqualTo, Object? isGreaterThan, Object? isGreaterThanOrEqualTo, Object? arrayContains, Iterable< Object?> ? arrayContainsAny, Iterable<Object?> ? whereIn, Iterable<Object?> ? whereNotIn, bool? isNull}) → Query<T> -
Adds a filter constraint to the query.
inherited
-
withConverter<
R extends Object?> ({required FromOracledb< R> fromOracledb, required ToOracledb<R> toOracledb}) → CollectionReference<R> -
Applies converters to the collection.
override
-
withVectorSearch(
Map< String, dynamic> vectorSearch) → Query<T> -
Returns a cloned query with vector search metadata attached.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited