-
Notifications
You must be signed in to change notification settings - Fork 36
Add more expansive #db.f cursor documentation
#573
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.
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
Draft
Fayti1703
wants to merge
1
commit into
comcode-org:main
Choose a base branch
from
Fayti1703:db/refine-cursor
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| --- | ||
| title: array(_and_close) | ||
| alias: array_and_close | ||
| --- | ||
|
|
||
| Retrieve all documents of the cursor, and close it. | ||
|
|
||
| ## Syntax | ||
|
|
||
| ``` | ||
| let cursor = #db.f(query, projection) | ||
| cursor.array() | ||
| ``` | ||
|
|
||
| or | ||
| ``` | ||
| let cursor = #db.f(query, projection) | ||
| cursor.array_and_close() | ||
| ``` | ||
|
|
||
| ### Parameters | ||
|
|
||
| No parameters. | ||
|
|
||
| ### Return | ||
|
|
||
| Returns all documents from the cursor, as an array of objects. | ||
|
|
||
| ## Cursor State | ||
|
|
||
| This function closes the cursor. If this is undesirable, try [array_and_keep_open](./array_and_keep_open). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| Close the cursor. | ||
|
|
||
| ## Syntax | ||
|
|
||
| ``` | ||
| let cursor = #db.f(query, projection) | ||
| cursor.close() | ||
| ``` | ||
|
|
||
| ### Parameters | ||
|
|
||
| No parameters. | ||
|
|
||
| ### Return | ||
|
|
||
| Always returns ((%Vnull%)). | ||
|
|
||
| ## Cursor State | ||
|
|
||
| This function closes the cursor. | ||
|
|
||
| ## Example | ||
|
|
||
| ```js | ||
| function(context, args) { | ||
| let cursor = #db.f({ type: "my_data" }); | ||
|
|
||
| // removing the following line causes an error: | ||
| cursor.close(); | ||
| } | ||
| ``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| --- | ||
| title: count(_and_close) | ||
| alias: count_and_close | ||
| --- | ||
|
|
||
| Retrieve the total number of documents of the cursor, and close it. | ||
|
|
||
| This method ignores `skip` and `limit` settings. | ||
|
|
||
| ## Syntax | ||
|
|
||
| ``` | ||
| let cursor = #db.f(query, projection) | ||
| cursor.count() | ||
| ``` | ||
|
|
||
| or | ||
| ``` | ||
| let cursor = #db.f(query, projection) | ||
| cursor.count_and_close() | ||
| ``` | ||
|
|
||
| ### Parameters | ||
|
|
||
| No parameters. | ||
|
|
||
| ### Return | ||
|
|
||
| The total number of documents of this cursor, as a number. | ||
|
|
||
| ## Cursor State | ||
|
|
||
| This function closes the cursor. If this is undesirable, try [count_and_keep_open](./count_and_keep_open). | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| --- | ||
| title: distinct(_and_close) | ||
| alias: distinct_and_close | ||
| --- | ||
|
|
||
| Retrieve the unique values of a given field for all documents of the cursor, and close it. | ||
|
|
||
| This method ignores `skip` and `limit` settings. | ||
|
|
||
| ## Syntax | ||
|
|
||
| ``` | ||
| let cursor = #db.f(query, projection) | ||
| cursor.distinct(field) | ||
| ``` | ||
|
|
||
| or | ||
| ``` | ||
| let cursor = #db.f(query, projection) | ||
| cursor.distinct_and_close(field) | ||
| ``` | ||
|
|
||
| ### Parameters | ||
|
|
||
| #### field | ||
|
|
||
| A string naming the field to pull unique values from. | ||
|
|
||
| ### Return | ||
|
|
||
| The unique values of the given field from all documents of the cursor, as an array. | ||
|
|
||
| ## Cursor State | ||
|
|
||
| This function closes the cursor. If this is undesirable, try [distinct_and_keep_open](./distinct_and_keep_open). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| --- | ||
| title: first(_and_close) | ||
| alias: first_and_close | ||
| --- | ||
|
|
||
| Retrieve the first document of the cursor, and close it. | ||
|
|
||
| ## Syntax | ||
|
|
||
| ``` | ||
| let cursor = #db.f(query, projection) | ||
| cursor.first() | ||
| ``` | ||
|
|
||
| or | ||
| ``` | ||
| let cursor = #db.f(query, projection) | ||
| cursor.first_and_close() | ||
| ``` | ||
|
|
||
| ### Parameters | ||
|
|
||
| No parameters. | ||
|
|
||
| ### Return | ||
|
|
||
| Returns the first document from the cursor as an object. | ||
| If the cursor is empty, returns ((%Vnull%)). | ||
|
|
||
| ## Cursor State | ||
|
|
||
| This function closes the cursor. If this is undesirable, try [first_and_keep_open](./first_and_keep_open). | ||
|
|
||
| ## Example | ||
|
|
||
| For the following examples, assume the database contains the following documents, inserted in that order: | ||
| ``` | ||
| { type: "my_data", my_key: "foo", order: 2 } | ||
| { type: "my_data", my_key: "bar", order: 1 } | ||
| ``` | ||
|
|
||
| ```js | ||
| function(context, args) { | ||
| let data = #db.f({ type: "my_data" }).first(); | ||
| return data; // { type: "my_data", my_key: "foo", order: 2 } | ||
| } | ||
| ``` | ||
|
|
||
| ```js | ||
| function(context, args) { | ||
| let data = #db.f({ type: "my_data" }).sort({ order: 1 }).first(); | ||
| return data; // { type: "my_data", my_key: "bar", order: 1 } | ||
| } | ||
| ``` | ||
|
|
||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
|
|
||
| Retrieve the first document of the cursor, keeping it open. | ||
|
|
||
| ## Syntax | ||
|
|
||
| ``` | ||
| let cursor = #db.f(query, projection) | ||
| cursor.first_and_keep_open() | ||
| // continue using `cursor`... | ||
| ``` | ||
|
|
||
| ### Parameters | ||
|
|
||
| No parameters. | ||
|
|
||
| ### Return | ||
|
|
||
| Returns the first document from the cursor as an object. | ||
| If the cursor is empty, returns ((%Vnull%)). | ||
|
|
||
| ## Cursor State | ||
|
|
||
| This function keeps the cursor open. | ||
|
|
||
| Try [first](./first) for a variant of this function that automatically closes the cursor. | ||
|
|
||
| ## Example | ||
|
|
||
| For the following example, assume the database contains the following documents, inserted in that order: | ||
| ``` | ||
| { type: "my_data", my_key: "foo", order: 2 } | ||
| { type: "my_data", my_key: "bar", order: 1 } | ||
| ``` | ||
|
|
||
| ```js | ||
| function(context, args) { | ||
| let cursor = #db.f({ type: "my_data" }); | ||
| let a = cursor.skip(1).first_and_keep_open(); | ||
| let b = cursor.skip(0).first_and_close(); | ||
| return [ a.my_key, b.my_key ]; // [ "bar", "foo" ] | ||
| } | ||
| ``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| --- | ||
| title: Cursors | ||
| sidebar_collapsible: true | ||
| sidebar_collapsed: true | ||
| --- | ||
|
|
||
| Database cursors are special objects returned from [#db.f(..)](../db.f). | ||
|
|
||
| ## Usage | ||
|
|
||
| Cursors are exclusively returned from #db.f(..): | ||
|
|
||
| ``` | ||
| let cursor = #db.f(query, projection) | ||
| ``` | ||
|
|
||
| A cursor _MUST_ be closed before the script run finishes, otherwise the following error occurs: | ||
|
|
||
| > `:::TRUST COMMUNICATION::: 1 db cursors were left open at end of script run` | ||
|
|
||
| Cursors can be closed via the [close](./close) method, or by using a terminating method such as [`first`](./first). | ||
|
|
||
| After a cursor is closed, it can no longer be used. Subsequent attempts to use the cursor result in the following error: | ||
|
|
||
| > `:::TRUST COMMUNICATION::: cursor was invalid. this can happen if it was used after being closed` | ||
|
|
||
| ### Cursor Handles | ||
|
|
||
| ((%FTODO: Write something that people who have never used a file descriptor in their life can understand.%)) | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. For a first version of this page, this TODO (and other TODOs) can be pulled if you're interested in getting this merged before completing this part |
||
|
|
||
| <details> | ||
| <summary>Technical details</summary> | ||
|
|
||
| A cursor is a wrapper object around a _"cursor handle"_. | ||
| `#db.f` always returns a cursor with a new, unique "cursor handle". | ||
|
|
||
| Multiple cursor objects can refer to the same "cursor handle". | ||
| See [skip](./skip) for a method that causes this to happen. | ||
|
|
||
| When _any_ cursor with a given "cursor handle" is closed, _all_ cursors for that "cursor handle" become invalid. | ||
| (You only need to close one cursor for each "cursor handle" to avoid the 'cursors were left open' error.) | ||
|
|
||
| Cursor objects that use the same "cursor handle" are nevertheless separate objects, and do not compare equal. | ||
|
|
||
| Note that your code will never interact with a "cursor handle" directly, only with cursor objects. | ||
|
|
||
| </details> | ||
|
|
||
| ## Methods | ||
|
|
||
| The following is an auto-generated list of cursor methods: | ||
|
|
||
| import DocCardList from '@theme/DocCardList'; | ||
|
|
||
| <DocCardList /> | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| Set the limit of the cursor. | ||
|
|
||
| ## Syntax | ||
|
|
||
| ``` | ||
| let cursor = #db.f(query, projection) | ||
| cursor.limit(count) | ||
| ``` | ||
|
|
||
| ### Parameters | ||
|
|
||
| #### count | ||
|
|
||
| The maximum number of results to return. | ||
| If this parameter is `0`, the limit is removed. | ||
|
|
||
| ### Return | ||
|
|
||
| Returns a new cursor, with the same handle as the input cursor. | ||
|
|
||
| This can be used to chain into other methods. | ||
|
|
||
| ## Cursor State | ||
|
|
||
| This function keeps the cursor open. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| Set the skip count of the cursor. | ||
|
|
||
| ## Syntax | ||
|
|
||
| ``` | ||
| let cursor = #db.f(query, projection) | ||
| cursor.skip(skip) | ||
| ``` | ||
|
|
||
| ### Parameters | ||
|
|
||
| #### skip | ||
|
|
||
| The number of results to skip. | ||
| Note that this is not cumulative; `cursor.skip(5).skip(1)` will skip 1 document, not 6. | ||
|
|
||
| ### Return | ||
|
|
||
| Returns a new cursor, with the same handle as the input cursor. | ||
|
|
||
| This can be used to chain into other methods. | ||
|
|
||
| ## Cursor State | ||
|
|
||
| This function keeps the cursor open. |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This page does not exist yet
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There's a few missing pages:
count_and_keep_open(which you mentioned)distinct_and_keep_openeach(_and_close)each_and_keep_opensort