Send feedback
Class Row (3.6.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version 3.6.0 keyboard_arrow_down
Create a Row object to interact with your table rows.
Package
@google-cloud/bigtable!
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
Property Value
data
Property Value
id
Property Value
key
Property Value
Property Value
table
Property Value
Methods
create(options)
create ( options ?: CreateRowOptions ) : Promise<CreateRowResponse> ;
Parameter
Returns
Type Description Promise <CreateRowResponse >
create(options, callback)
create ( options : CreateRowOptions , callback : CreateRowCallback ) : void ;
Parameters
Returns
create(callback)
create ( callback : CreateRowCallback ) : void ;
Parameter
Name Description callback
CreateRowCallback
Returns
createRules(rules, options)
createRules ( rules : Rule | Rule [], options ?: CallOptions ) : Promise<CreateRulesResponse> ;
Parameters
Name Description rules
Rule | Rule []
options
CallOptions
Returns
Type Description Promise <CreateRulesResponse >
createRules(rules, options, callback)
createRules ( rules : Rule | Rule [], options : CallOptions , callback : CreateRulesCallback ) : void ;
Parameters
Name Description rules
Rule | Rule []
options
CallOptions
callback
CreateRulesCallback
Returns
createRules(rules, callback)
createRules ( rules : Rule | Rule [], callback : CreateRulesCallback ) : void ;
Parameters
Name Description rules
Rule | Rule []
callback
CreateRulesCallback
Returns
delete(options)
delete ( options ?: CallOptions ) : Promise<MutateResponse> ;
Parameter
Name Description options
CallOptions
Returns
Type Description Promise <MutateResponse >
delete(options, callback)
delete ( options : CallOptions , callback : MutateCallback ) : void ;
Parameters
Name Description options
CallOptions
callback
MutateCallback
Returns
delete(callback)
delete ( callback : MutateCallback ) : void ;
Parameter
Name Description callback
MutateCallback
Returns
deleteCells(columns, options)
deleteCells ( columns : string [], options ?: CallOptions ) : Promise<MutateResponse> ;
Parameters
Name Description columns
string[]
options
CallOptions
Returns
Type Description Promise <MutateResponse >
deleteCells(columns, options, callback)
deleteCells ( columns : string [], options : CallOptions , callback : MutateCallback ) : void ;
Parameters
Name Description columns
string[]
options
CallOptions
callback
MutateCallback
Returns
deleteCells(columns, callback)
deleteCells ( columns : string [], callback : MutateCallback ) : void ;
Parameters
Name Description columns
string[]
callback
MutateCallback
Returns
exists(options)
exists ( options ?: CallOptions ) : Promise<RowExistsResponse> ;
Parameter
Name Description options
CallOptions
Returns
Type Description Promise <RowExistsResponse >
exists(options, callback)
exists ( options : CallOptions , callback : RowExistsCallback ) : void ;
Parameters
Name Description options
CallOptions
callback
RowExistsCallback
Returns
exists(callback)
exists ( callback : RowExistsCallback ) : void ;
Parameter
Name Description callback
RowExistsCallback
Returns
filter(filter, config)
filter ( filter : RawFilter , config ?: FilterConfig ) : Promise<FilterResponse> ;
Parameters
Returns
Type Description Promise <FilterResponse >
filter(filter, config, callback)
filter ( filter : RawFilter , config : FilterConfig , callback : FilterCallback ) : void ;
Parameters
Name Description filter
RawFilter
config
FilterConfig
callback
FilterCallback
Returns
filter(filter, callback)
filter ( filter : RawFilter , callback : FilterCallback ) : void ;
Parameters
Name Description filter
RawFilter
callback
FilterCallback
Returns
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.
Parameters
Returns
static formatFamilies_ ( families : google . bigtable . v2 . IFamily [], options ?: FormatFamiliesOptions ) : {
[ index : string ] : {};
};
Formats a rowContents object into friendly format.
Parameters
Name Description families
google.bigtable.v2.IFamily []
The row families.
options
FormatFamiliesOptions
Formatting options.
Returns
Type Description {
[index: string]: {};
}
get(options)
get ( options ?: GetRowOptions ) : Promise<GetRowResponse<Row> >;
Parameter
Returns
Type Description Promise <GetRowResponse <Row >>
get(columns, options)
get<T = any >( columns : string [], options ?: GetRowOptions ) : Promise<GetRowResponse<T> >;
Parameters
Returns
Type Description Promise <GetRowResponse <T>>
Type Parameter
get(columns, options, callback)
get<T = any >( columns : string [], options : GetRowOptions , callback : GetRowCallback<T> ) : void ;
Parameters
Name Description columns
string[]
options
GetRowOptions
callback
GetRowCallback <T>
Returns
Type Parameter
get(columns, callback)
get<T = any >( columns : string [], callback : GetRowCallback<T> ) : void ;
Parameters
Name Description columns
string[]
callback
GetRowCallback <T>
Returns
Type Parameter
get(callback)
get ( callback : GetRowCallback<Row> ) : void ;
Parameter
Name Description callback
GetRowCallback <Row >
Returns
get(options, callback)
get ( options : GetRowOptions , callback : GetRowCallback<Row> ) : void ;
Parameters
Returns
getMetadata ( options ?: GetRowOptions ) : Promise<GetRowMetadataResponse> ;
Parameter
Returns
Type Description Promise <GetRowMetadataResponse >
getMetadata ( options : GetRowOptions , callback : GetRowMetadataCallback ) : void ;
Parameters
Name Description options
GetRowOptions
callback
GetRowMetadataCallback
Returns
getMetadata ( callback : GetRowMetadataCallback ) : void ;
Parameter
Name Description callback
GetRowMetadataCallback
Returns
increment(column, value)
increment ( column : string , value ?: number ) : Promise<IncrementResponse> ;
Parameters
Name Description column
string
value
number
Returns
Type Description Promise <IncrementResponse >
increment(column, value, options)
increment ( column : string , value : number , options ?: CallOptions ) : Promise<IncrementResponse> ;
Parameters
Name Description column
string
value
number
options
CallOptions
Returns
Type Description Promise <IncrementResponse >
increment(column, options)
increment ( column : string , options ?: CallOptions ) : Promise<IncrementResponse> ;
Parameters
Name Description column
string
options
CallOptions
Returns
Type Description Promise <IncrementResponse >
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
increment(column, value, callback)
increment ( column : string , value : number , callback : IncrementCallback ) : void ;
Parameters
Name Description column
string
value
number
callback
IncrementCallback
Returns
increment(column, options, callback)
increment ( column : string , options : CallOptions , callback : IncrementCallback ) : void ;
Parameters
Name Description column
string
options
CallOptions
callback
IncrementCallback
Returns
increment(column, callback)
increment ( column : string , callback : IncrementCallback ) : void ;
Parameters
Name Description column
string
callback
IncrementCallback
Returns
save(entry, options)
save ( entry : Entry , options ?: CallOptions ) : Promise<MutateResponse> ;
Parameters
Name Description entry
Entry
options
CallOptions
Returns
Type Description Promise <MutateResponse >
save(entry, options, callback)
save ( entry : Entry , options : CallOptions , callback : MutateCallback ) : void ;
Parameters
Name Description entry
Entry
options
CallOptions
callback
MutateCallback
Returns
save(entry, callback)
save ( entry : Entry , callback : MutateCallback ) : void ;
Parameters
Name Description entry
Entry
callback
MutateCallback
Returns
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-06 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-06 UTC."],[],[]]