Class Family (4.6.1)

Create a Family object to interact with your table column families.

Package

Example


const {Bigtable} = require('@google-cloud/bigtable');
const bigtable = new Bigtable();
const instance = bigtable.instance('my-instance');
const table = instance.table('prezzy');
const family = table.family('follows');

Constructors

(constructor)(table, id)

constructor(table: Table, id: string);

Constructs a new instance of the Family class

Parameters
Name	Description
`table`	`Table`
`id`	`string`

Properties

bigtable

bigtable: Bigtable;

id

id: string;

metadata

metadata?: IColumnFamily;

name

name: string;

table

table: Table;

Methods

create(options)

create(options?: CreateFamilyOptions): Promise<CreateFamilyResponse>;

Parameter
Name	Description
`options`	`CreateFamilyOptions`

Returns
Type	Description
`Promise<CreateFamilyResponse>`

create(options, callback)

create(options: CreateFamilyOptions, callback: CreateFamilyCallback): void;

Parameters
Name	Description
`options`	`CreateFamilyOptions`
`callback`	`CreateFamilyCallback`

Returns
Type	Description
`void`

create(callback)

create(callback: CreateFamilyCallback): void;

Parameter
Name	Description
`callback`	`CreateFamilyCallback`

Returns
Type	Description
`void`

delete(gaxOptions)

delete(gaxOptions?: CallOptions): Promise<DeleteFamilyResponse>;

Parameter
Name	Description
`gaxOptions`	`CallOptions`

Returns
Type	Description
`Promise<DeleteFamilyResponse>`

delete(gaxOptions, callback)

delete(gaxOptions: CallOptions, callback: DeleteFamilyCallback): void;

Parameters
Name	Description
`gaxOptions`	`CallOptions`
`callback`	`DeleteFamilyCallback`

Returns
Type	Description
`void`

delete(callback)

delete(callback: DeleteFamilyCallback): void;

Parameter
Name	Description
`callback`	`DeleteFamilyCallback`

Returns
Type	Description
`void`

exists(gaxOptions)

exists(gaxOptions?: CallOptions): Promise<FamilyExistsResponse>;

Parameter
Name	Description
`gaxOptions`	`CallOptions`

Returns
Type	Description
`Promise<FamilyExistsResponse>`

exists(gaxOptions, callback)

exists(gaxOptions: CallOptions, callback: FamilyExistsCallback): void;

Parameters
Name	Description
`gaxOptions`	`CallOptions`
`callback`	`FamilyExistsCallback`

Returns
Type	Description
`void`

exists(callback)

exists(callback: FamilyExistsCallback): void;

Parameter
Name	Description
`callback`	`FamilyExistsCallback`

Returns
Type	Description
`void`

formatRule_(ruleObj)

static formatRule_(ruleObj: GcRule): IGcRule;

Formats Garbage Collection rule into proto format.

Parameter
Name	Description
`ruleObj`	`GcRule` The rule object.

Returns
Type	Description
`IGcRule`	{object}

Example


Family.formatRule({
  age: {
    seconds: 10000,
    nanos: 10000
  },
  versions: 2,
  union: true
});
// {
//   union: {
//     rules: [
//       {
//         maxAge: {
//           seconds: 10000,
//           nanos: 10000
//         }
//       }, {
//         maxNumVersions: 2
//       }
//     ]
//   }
// }

get(options)

get(options?: GetFamilyOptions): Promise<GetFamilyResponse>;

Parameter
Name	Description
`options`	`GetFamilyOptions`

Returns
Type	Description
`Promise<GetFamilyResponse>`

get(options, callback)

get(options: GetFamilyOptions, callback: GetFamilyCallback): void;

Parameters
Name	Description
`options`	`GetFamilyOptions`
`callback`	`GetFamilyCallback`

Returns
Type	Description
`void`

get(callback)

get(callback: GetFamilyCallback): void;

Parameter
Name	Description
`callback`	`GetFamilyCallback`

Returns
Type	Description
`void`

getMetadata(gaxOptions)

getMetadata(gaxOptions?: CallOptions): Promise<GetFamilyMetadataResponse>;

Parameter
Name	Description
`gaxOptions`	`CallOptions`

Returns
Type	Description
`Promise<GetFamilyMetadataResponse>`

getMetadata(gaxOptions, callback)

getMetadata(gaxOptions: CallOptions, callback: GetFamilyMetadataCallback): void;

Parameters
Name	Description
`gaxOptions`	`CallOptions`
`callback`	`GetFamilyMetadataCallback`

Returns
Type	Description
`void`

getMetadata(callback)

getMetadata(callback: GetFamilyMetadataCallback): void;

Parameter
Name	Description
`callback`	`GetFamilyMetadataCallback`

Returns
Type	Description
`void`

setMetadata(metadata, gaxOptions)

setMetadata(metadata: SetFamilyMetadataOptions, gaxOptions?: CallOptions): Promise<SetFamilyMetadataResponse>;

Parameters
Name	Description
`metadata`	`SetFamilyMetadataOptions`
`gaxOptions`	`CallOptions`

Returns
Type	Description
`Promise<SetFamilyMetadataResponse>`

setMetadata(metadata, gaxOptions, callback)

setMetadata(metadata: SetFamilyMetadataOptions, gaxOptions: CallOptions, callback: SetFamilyMetadataCallback): void;

Parameters
Name	Description
`metadata`	`SetFamilyMetadataOptions`
`gaxOptions`	`CallOptions`
`callback`	`SetFamilyMetadataCallback`

Returns
Type	Description
`void`

setMetadata(metadata, callback)

setMetadata(metadata: SetFamilyMetadataOptions, callback: SetFamilyMetadataCallback): void;

Parameters
Name	Description
`metadata`	`SetFamilyMetadataOptions`
`callback`	`SetFamilyMetadataCallback`

Returns
Type	Description
`void`