Send feedback
Class Row (5.0.0)
bookmark_border bookmark
Stay organized with collections
Save and categorize content based on your preferences.
On this page Package Example Constructors Properties Methods create(options) create(options, callback) create(callback) createRules(rules, options) createRules(rules, options, callback) createRules(rules, callback) delete(options) delete(options, callback) delete(callback) deleteCells(columns, options) deleteCells(columns, options, callback) deleteCells(columns, callback) exists(options) exists(options, callback) exists(callback) filter(filter, config) filter(filter, config, callback) filter(filter, callback) formatChunks_(chunks, options) formatFamilies_(families, options) get(options) get(columns, options) get(columns, options, callback) get(columns, callback) get(callback) get(options, callback) getMetadata(options) getMetadata(options, callback) getMetadata(callback) increment(column, value) increment(column, value, options) increment(column, options) increment(column, value, options, callback) increment(column, value, callback) increment(column, options, callback) increment(column, callback) save(entry, options) save(entry, options, callback) save(entry, callback)
Version 5.0.0 keyboard_arrow_down
Create a Row object to interact with your table rows.
Package
@google-cloud/bigtable
Example
const { Bigtable } = require ( '@google-cloud/bigtable' );
const bigtable = new Bigtable ();
const instance = bigtable . instance ( 'my-instance' );
const table = instance . table ( 'prezzy' );
const row = table . row ( 'gwashington' );
Constructors
(constructor)(table, key)
constructor ( table : Table , key : string );
Constructs a new instance of the Row class
Parameters
Name Description
table
Table
key
string
Properties
bigtable
data
id
key
table
Methods
create(options)
create ( options ?: CreateRowOptions ) : Promise<CreateRowResponse> ;
create(options, callback)
create ( options : CreateRowOptions , callback : CreateRowCallback ) : void ;
Returns
Type Description
void
create(callback)
create ( callback : CreateRowCallback ) : void ;
Returns
Type Description
void
createRules(rules, options)
createRules ( rules : Rule | Rule [], options ?: CallOptions ) : Promise<CreateRulesResponse> ;
Parameters
Name Description
rules
Rule | Rule []
options
CallOptions
createRules(rules, options, callback)
createRules ( rules : Rule | Rule [], options : CallOptions , callback : CreateRulesCallback ) : void ;
Returns
Type Description
void
createRules(rules, callback)
createRules ( rules : Rule | Rule [], callback : CreateRulesCallback ) : void ;
Returns
Type Description
void
delete(options)
delete ( options ?: CallOptions ) : Promise<MutateResponse> ;
Parameter
Name Description
options
CallOptions
delete(options, callback)
delete ( options : CallOptions , callback : MutateCallback ) : void ;
Parameters
Name Description
options
CallOptions
callback
MutateCallback
Returns
Type Description
void
delete(callback)
delete ( callback : MutateCallback ) : void ;
Returns
Type Description
void
deleteCells(columns, options)
deleteCells ( columns : string [], options ?: CallOptions ) : Promise<MutateResponse> ;
Parameters
Name Description
columns
string[]
options
CallOptions
deleteCells(columns, options, callback)
deleteCells ( columns : string [], options : CallOptions , callback : MutateCallback ) : void ;
Parameters
Name Description
columns
string[]
options
CallOptions
callback
MutateCallback
Returns
Type Description
void
deleteCells(columns, callback)
deleteCells ( columns : string [], callback : MutateCallback ) : void ;
Returns
Type Description
void
exists(options)
exists ( options ?: CallOptions ) : Promise<RowExistsResponse> ;
Parameter
Name Description
options
CallOptions
exists(options, callback)
exists ( options : CallOptions , callback : RowExistsCallback ) : void ;
Returns
Type Description
void
exists(callback)
exists ( callback : RowExistsCallback ) : void ;
Returns
Type Description
void
filter(filter, config)
filter ( filter : RawFilter , config ?: FilterConfig ) : Promise<FilterResponse> ;
filter(filter, config, callback)
filter ( filter : RawFilter , config : FilterConfig , callback : FilterCallback ) : void ;
Returns
Type Description
void
filter(filter, callback)
filter ( filter : RawFilter , callback : FilterCallback ) : void ;
Returns
Type Description
void
static formatChunks_ ( chunks : Chunk [], options ?: ConvertFromBytesUserOptions ) : Row [];
Formats the row chunks into friendly format. Chunks contain 3 properties:
rowContents The row contents, this essentially is all data pertaining to a single family.
commitRow This is a boolean telling us the all previous chunks for this row are ok to consume.
resetRow This is a boolean telling us that all the previous chunks are to be discarded.
Returns
Type Description
Row []
Example
Row . formatChunks_ ( chunks );
// {
// follows: {
// gwashington: [
// {
// value: 2
// }
// ]
// }
// }
static formatFamilies_ ( families : google . bigtable . v2 . IFamily [], options ?: FormatFamiliesOptions ) : {
[ index : string ] : {};
};
Formats a rowContents object into friendly format.
Returns
Type Description
{
[index: string]: {};
}
Example
const families = [
{
name : 'follows' ,
columns : [
{
qualifier : 'gwashington' ,
cells : [
{
value : 2
}
]
}
]
}
];
Row . formatFamilies_ ( families );
// {
// follows: {
// gwashington: [
// {
// value: 2
// }
// ]
// }
// }
get(options)
get ( options ?: GetRowOptions ) : Promise<GetRowResponse<Row> >;
get(columns, options)
get<T = any >( columns : string [], options ?: GetRowOptions ) : Promise<GetRowResponse<T> >;
Parameters
Name Description
columns
string[]
options
GetRowOptions
Type Parameter
Name Description
T
get(columns, options, callback)
get<T = any >( columns : string [], options : GetRowOptions , callback : GetRowCallback<T> ) : void ;
Returns
Type Description
void
Type Parameter
Name Description
T
get(columns, callback)
get<T = any >( columns : string [], callback : GetRowCallback<T> ) : void ;
Parameters
Name Description
columns
string[]
callback
GetRowCallback <T>
Returns
Type Description
void
Type Parameter
Name Description
T
get(callback)
get ( callback : GetRowCallback<Row> ) : void ;
Returns
Type Description
void
get(options, callback)
get ( options : GetRowOptions , callback : GetRowCallback<Row> ) : void ;
Returns
Type Description
void
getMetadata ( options ?: GetRowOptions ) : Promise<GetRowMetadataResponse> ;
getMetadata ( options : GetRowOptions , callback : GetRowMetadataCallback ) : void ;
Returns
Type Description
void
getMetadata ( callback : GetRowMetadataCallback ) : void ;
Returns
Type Description
void
increment(column, value)
increment ( column : string , value ?: number ) : Promise<IncrementResponse> ;
Parameters
Name Description
column
string
value
number
increment(column, value, options)
increment ( column : string , value : number , options ?: CallOptions ) : Promise<IncrementResponse> ;
Parameters
Name Description
column
string
value
number
options
CallOptions
increment(column, options)
increment ( column : string , options ?: CallOptions ) : Promise<IncrementResponse> ;
Parameters
Name Description
column
string
options
CallOptions
increment(column, value, options, callback)
increment ( column : string , value : number , options : CallOptions , callback : IncrementCallback ) : void ;
Parameters
Name Description
column
string
value
number
options
CallOptions
callback
IncrementCallback
Returns
Type Description
void
increment(column, value, callback)
increment ( column : string , value : number , callback : IncrementCallback ) : void ;
Returns
Type Description
void
increment(column, options, callback)
increment ( column : string , options : CallOptions , callback : IncrementCallback ) : void ;
Parameters
Name Description
column
string
options
CallOptions
callback
IncrementCallback
Returns
Type Description
void
increment(column, callback)
increment ( column : string , callback : IncrementCallback ) : void ;
Returns
Type Description
void
save(entry, options)
save ( entry : Entry , options ?: CallOptions ) : Promise<MutateResponse> ;
Parameters
Name Description
entry
Entry
options
CallOptions
save(entry, options, callback)
save ( entry : Entry , options : CallOptions , callback : MutateCallback ) : void ;
Returns
Type Description
void
save(entry, callback)
save ( entry : Entry , callback : MutateCallback ) : void ;
Returns
Type Description
void
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-02-28 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-02-28 UTC."],[],[]]
