Methods
create(optionsopt, callback)
Create a column family.
Parameters:
| Name | Type | Attributes | Description | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
object |
<optional> |
See Table#createFamily. |
||||||||||||||||
callback |
function |
The callback function. Properties
|
delete(gaxOptionsopt, callbackopt)
Delete the column family.
Parameters:
| Name | Type | Attributes | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
gaxOptions |
object |
<optional> |
Request configuration options, outlined here: https://googleapis.github.io/gax-nodejs/CallSettings.html. |
||||||||||||
callback |
function |
<optional> |
The callback function. Properties
|
exists(gaxOptionsopt, callback)
Check if the column family exists.
Parameters:
| Name | Type | Attributes | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
gaxOptions |
object |
<optional> |
Request configuration options, outlined here: https://googleapis.github.io/gax-nodejs/CallSettings.html. |
||||||||||||
callback |
function |
The callback function. Properties
|
get(optionsopt)
Get a column family if it exists.
You may optionally use this to "get or create" an object by providing an
object with autoCreate set to true. Any extra configuration that is
normally required for the create method must be contained within this
object as well.
Parameters:
| Name | Type | Attributes | Description | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
object |
<optional> |
Configuration object. Properties
|
|||||||||||||||
callback.error |
error |
<nullable> |
An error returned while making this request. |
|||||||||||||||
callback.family |
Family |
The Family object. |
||||||||||||||||
callback.apiResponse |
object |
The resource as it exists in the API. |
getMetadata(gaxOptionsopt, callback)
Get the column family's metadata.
Parameters:
| Name | Type | Attributes | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
gaxOptions |
object |
<optional> |
Request configuration options, outlined here: https://googleapis.github.io/gax-nodejs/CallSettings.html. |
||||||||||||
callback |
function |
The callback function. Properties
|
Example
include:samples/api-reference-doc-snippets/family.js
region_tag:bigtable_api_get_family_meta
setMetadata(metadata, gaxOptionsopt, callback)
Set the column family's metadata.
See Table#createFamily for a detailed explanation of the arguments.
Parameters:
| Name | Type | Attributes | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata |
object |
Metadata object. Properties
|
|||||||||||||
gaxOptions |
object |
<optional> |
Request configuration options, outlined here: https://googleapis.github.io/gax-nodejs/global.html#CallOptions. |
||||||||||||
callback |
function |
The callback function. Properties
|