Class Row (5.0.0)

Create a Row object to interact with your table rows.

Package

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

bigtable: Bigtable;

data

data: any;

id

id: string;

key

key?: string;

metadata

metadata?: {};

table

table: Table;

Methods

create(options)

create(options?: CreateRowOptions): Promise<CreateRowResponse>;

Parameter
Name	Description
`options`	`CreateRowOptions`

Returns
Type	Description
`Promise<CreateRowResponse>`

create(options, callback)

create(options: CreateRowOptions, callback: CreateRowCallback): void;

Parameters
Name	Description
`options`	`CreateRowOptions`
`callback`	`CreateRowCallback`

Returns
Type	Description
`void`

create(callback)

create(callback: CreateRowCallback): void;

Parameter
Name	Description
`callback`	`CreateRowCallback`

Returns
Type	Description
`void`

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
Type	Description
`void`

createRules(rules, callback)

createRules(rules: Rule | Rule[], callback: CreateRulesCallback): void;

Parameters
Name	Description
`rules`	`Rule \| Rule[]`
`callback`	`CreateRulesCallback`

Returns
Type	Description
`void`

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
Type	Description
`void`

delete(callback)

delete(callback: MutateCallback): void;

Parameter
Name	Description
`callback`	`MutateCallback`

Returns
Type	Description
`void`

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
Type	Description
`void`

deleteCells(columns, callback)

deleteCells(columns: string[], callback: MutateCallback): void;

Parameters
Name	Description
`columns`	`string[]`
`callback`	`MutateCallback`

Returns
Type	Description
`void`

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
Type	Description
`void`

exists(callback)

exists(callback: RowExistsCallback): void;

Parameter
Name	Description
`callback`	`RowExistsCallback`

Returns
Type	Description
`void`

filter(filter, config)

filter(filter: RawFilter, config?: FilterConfig): Promise<FilterResponse>;

Parameters
Name	Description
`filter`	`RawFilter`
`config`	`FilterConfig`

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
Type	Description
`void`

filter(filter, callback)

filter(filter: RawFilter, callback: FilterCallback): void;

Parameters
Name	Description
`filter`	`RawFilter`
`callback`	`FilterCallback`

Returns
Type	Description
`void`

formatChunks_(chunks, options)

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
Name	Description
`chunks`	`Chunk[]` The list of chunks.
`options`	`ConvertFromBytesUserOptions` Formatting options.

Returns
Type	Description
`Row[]`

Example


Row.formatChunks_(chunks);
// {
//   follows: {
//     gwashington: [
//       {
//         value: 2
//       }
//     ]
//   }
// }

formatFamilies_(families, options)

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]: {}; }`

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>>;

Parameter
Name	Description
`options`	`GetRowOptions`

Returns
Type	Description
`Promise<GetRowResponse<Row>>`

get(columns, options)

get<T = any>(columns: string[], options?: GetRowOptions): Promise<GetRowResponse<T>>;

Parameters
Name	Description
`columns`	`string[]`
`options`	`GetRowOptions`

Returns
Type	Description
`Promise<GetRowResponse<T>>`

Type Parameter
Name	Description
`T`

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	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;

Parameter
Name	Description
`callback`	`GetRowCallback<Row>`

Returns
Type	Description
`void`

get(options, callback)

get(options: GetRowOptions, callback: GetRowCallback<Row>): void;

Parameters
Name	Description
`options`	`GetRowOptions`
`callback`	`GetRowCallback<Row>`

Returns
Type	Description
`void`

getMetadata(options)

getMetadata(options?: GetRowOptions): Promise<GetRowMetadataResponse>;

Parameter
Name	Description
`options`	`GetRowOptions`

Returns
Type	Description
`Promise<GetRowMetadataResponse>`

getMetadata(options, callback)

getMetadata(options: GetRowOptions, callback: GetRowMetadataCallback): void;

Parameters
Name	Description
`options`	`GetRowOptions`
`callback`	`GetRowMetadataCallback`

Returns
Type	Description
`void`

getMetadata(callback)

getMetadata(callback: GetRowMetadataCallback): void;

Parameter
Name	Description
`callback`	`GetRowMetadataCallback`

Returns
Type	Description
`void`

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
Type	Description
`void`

increment(column, value, callback)

increment(column: string, value: number, callback: IncrementCallback): void;

Parameters
Name	Description
`column`	`string`
`value`	`number`
`callback`	`IncrementCallback`

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;

Parameters
Name	Description
`column`	`string`
`callback`	`IncrementCallback`

Returns
Type	Description
`void`

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
Type	Description
`void`

save(entry, callback)

save(entry: Entry, callback: MutateCallback): void;

Parameters
Name	Description
`entry`	`Entry`
`callback`	`MutateCallback`

Returns
Type	Description
`void`