Create a Family object to interact with your table column families.
Package
@google-cloud/bigtableExample
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
Properties
bigtable
bigtable
:
Bigtable
;
id
id
:
string
;
metadata
metadata
?:
IColumnFamily
;
name
name
:
string
;
table
table
:
Table
;
Methods
create(options)
create
(
options
?:
CreateFamilyOptions
)
:
Promise<CreateFamilyResponse>
;
create(options, callback)
create
(
options
:
CreateFamilyOptions
,
callback
:
CreateFamilyCallback
)
:
void
;
Returns
Type
Description
void
create(callback)
create
(
callback
:
CreateFamilyCallback
)
:
void
;
Returns
Type
Description
void
delete(gaxOptions)
delete
(
gaxOptions
?:
CallOptions
)
:
Promise<DeleteFamilyResponse>
;
Parameter
Name
Description
gaxOptions
CallOptions
delete(gaxOptions, callback)
delete
(
gaxOptions
:
CallOptions
,
callback
:
DeleteFamilyCallback
)
:
void
;
Returns
Type
Description
void
delete(callback)
delete
(
callback
:
DeleteFamilyCallback
)
:
void
;
Returns
Type
Description
void
exists(gaxOptions)
exists
(
gaxOptions
?:
CallOptions
)
:
Promise<FamilyExistsResponse>
;
Parameter
Name
Description
gaxOptions
CallOptions
exists(gaxOptions, callback)
exists
(
gaxOptions
:
CallOptions
,
callback
:
FamilyExistsCallback
)
:
void
;
Returns
Type
Description
void
exists(callback)
exists
(
callback
:
FamilyExistsCallback
)
:
void
;
Returns
Type
Description
void
formatRule_(ruleObj)
static
formatRule_
(
ruleObj
:
GcRule
)
:
IGcRule
;
Formats Garbage Collection rule into proto format.
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>
;
get(options, callback)
get
(
options
:
GetFamilyOptions
,
callback
:
GetFamilyCallback
)
:
void
;
Returns
Type
Description
void
get(callback)
get
(
callback
:
GetFamilyCallback
)
:
void
;
Returns
Type
Description
void
getMetadata(gaxOptions)
getMetadata
(
gaxOptions
?:
CallOptions
)
:
Promise<GetFamilyMetadataResponse>
;
Parameter
Name
Description
gaxOptions
CallOptions
getMetadata(gaxOptions, callback)
getMetadata
(
gaxOptions
:
CallOptions
,
callback
:
GetFamilyMetadataCallback
)
:
void
;
Returns
Type
Description
void
getMetadata(callback)
getMetadata
(
callback
:
GetFamilyMetadataCallback
)
:
void
;
Returns
Type
Description
void
setMetadata(metadata, gaxOptions)
setMetadata
(
metadata
:
SetFamilyMetadataOptions
,
gaxOptions
?:
CallOptions
)
:
Promise<SetFamilyMetadataResponse>
;
setMetadata(metadata, gaxOptions, callback)
setMetadata
(
metadata
:
SetFamilyMetadataOptions
,
gaxOptions
:
CallOptions
,
callback
:
SetFamilyMetadataCallback
)
:
void
;
Parameters
Name
Description
metadata
gaxOptions
CallOptions
callback
Returns
Type
Description
void
setMetadata(metadata, callback)
setMetadata
(
metadata
:
SetFamilyMetadataOptions
,
callback
:
SetFamilyMetadataCallback
)
:
void
;
Returns
Type
Description
void
