FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Document the order of cells within a row. by coryan · Pull Request #146 · googleapis/google-cloud-cpp · GitHub

/ google-cloud-cpp Public

Document the order of cells within a row. #146

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
mbrukman merged 3 commits into from
Dec 28, 2017
Conversation 30 Commits 3 Checks 0 Files changed
Merged

Document the order of cells within a row. #146

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8aa0e14
Document the order of cells within a row.
coryan Dec 26, 2017
4218e5e
Rephrase the ordering guarantees per review.
coryan Dec 26, 2017
4e8846a
Address comments from review.
coryan Dec 28, 2017
File filter

Filter by extension

Filter by extension .h  (1) All 1 file type selected
Viewed files
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Unified
Split
Hide whitespace
Diff view
Unified
Split
Hide whitespace
41 changes: 22 additions & 19 deletions bigtable/client/filters.h
Show comments
View file
Open in desktop
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
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -196,14 +196,17 @@ class Filter {
/**
* Return a filter that only accepts the first @p n cells in a row.
*
* Notice that cells might be repeated, such as when interleaving the results
* of multiple filters via the Union() function (aka Interleaved in the
* proto). Furthermore, notice that this is the cells within a row, if there
* are multiple column families and columns, the cells are returned ordered
* by first column family, and then by column qualifier, and then by
* timestamp.
*
* TODO(#82) - check the documentation around ordering of columns.
* Note that cells might be repeated, such as when interleaving the results
* of multiple filters via the `Interleave()` function. Furthermore, this
* filter apples to the cells within a row; if there are multiple column
* families and/or columns in a row, the order is:
* - All the cells for a column family appear together, but there is no
* guarantee on the order of the column families. Furthermore, column
* families may appear in different orders in different rows.
* - Within a column family, the cells are ordered by column name, where
* column names are sorted lexicographically.
* - Within a column, the cells appear in descending order by timestamp.
*
* TODO(#84) - document what is the effect of n <= 0
*/
static Filter CellsRowLimit(std::int32_t n) {
Expand All @@ -215,17 +218,17 @@ class Filter {
/**
* Return a filter that skips the first @p n cells in a row.
*
* Notice that cells might be repeated, such as when interleaving the results
* of multiple filters via the Union() function (aka Interleaved in the
* proto). Furthermore, notice that this is the cells within a row, if there
* are multiple column families and columns, the cells are returned ordered
* by:
* - The column family internal ID, which is not necessarily the
* lexicographical order of the column family names.
* - The column names, lexicographically.
* - Timestamp in reverse order.
*
* TODO(#82) - check the documentation around ordering of columns.
* Note that cells might be repeated, such as when interleaving the results
* of multiple filters via the `Interleave()` function. Furthermore, this
* filter apples to the cells within a row; if there are multiple column
* families and/or columns in a row, the order is:
* - All the cells for a column family appear together, but there is no
* guarantee on the order of the column families. Furthermore, column
* families may appear in different orders in different rows.
* - Within a column family, the cells are ordered by column name, where
* column names are sorted lexicographically.
* - Within a column, the cells appear in descending order by timestamp.
*
* TODO(#84) - document what is the effect of n <= 0
*/
static Filter CellsRowOffset(std::int32_t n) {
Expand Down
Back | FazBrowse Home | New Git URL