Skip to content

Adds await collection.length() shorthand method #229

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 13, 2024
Merged

Adds await collection.length() shorthand method #229

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion src/collections/collection/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,12 @@ export interface Collection<T = undefined, N = string> {
* are returned. Use `wvc.QueryReference` to specify which references to return.
*/
iterator: (opts?: IteratorOptions<T>) => Iterator<T>;
/**
* Use this method to return the total number of objects in the collection.
*
* This is a short-hand for calling `collection.aggregate.overAll().then(({ totalCount }) => totalCount)`.
*/
length: () => Promise<number>;
/**
* Use this method to return a collection object specific to a single consistency level.
*
Expand Down Expand Up @@ -111,9 +117,16 @@ const collection = <T, N>(
throw new WeaviateInvalidInputError(`The collection name must be a string, got: ${typeof name}`);
}
const capitalizedName = capitalizeCollectionName(name);
const aggregateCollection = aggregate<T>(
connection,
capitalizedName,
dbVersionSupport,
consistencyLevel,
tenant
);
const queryCollection = query<T>(connection, capitalizedName, dbVersionSupport, consistencyLevel, tenant);
return {
aggregate: aggregate<T>(connection, capitalizedName, dbVersionSupport, consistencyLevel, tenant),
aggregate: aggregateCollection,
backup: backupCollection(connection, capitalizedName),
config: config<T>(connection, capitalizedName, dbVersionSupport, tenant),
data: data<T>(connection, capitalizedName, dbVersionSupport, consistencyLevel, tenant),
Expand All @@ -139,6 +152,7 @@ const collection = <T, N>(
})
.then((res) => res.objects)
),
length: () => aggregateCollection.overAll().then(({ totalCount }) => totalCount),
withConsistency: (consistencyLevel: ConsistencyLevel) =>
collection<T, N>(connection, capitalizedName, dbVersionSupport, consistencyLevel, tenant),
withTenant: <TT extends TenantBase>(tenant: string | TT) =>
Expand Down
Loading