Module column_family (2.1.0)

Version 2.1.0

• 2.26.0 (latest)
• 2.25.0
• 2.24.0
• 2.23.1
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.1
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.1
• 2.13.2
• 2.12.0
• 2.11.3
• 2.10.1
• 2.9.0
• 2.8.1
• 2.7.1
• 2.6.0
• 2.5.2
• 2.4.0
• 2.3.3
• 2.2.0
• 2.1.0
• 2.0.0
• 1.7.3
• 1.6.1
• 1.5.1
• 1.4.0
• 1.3.0
• 1.2.1
• 1.1.0
• 1.0.0
• 0.34.0

User friendly container for Google Cloud Bigtable Column Family.

Classes

ColumnFamily

ColumnFamily(column_family_id, table, gc_rule=None)

Representation of a Google Cloud Bigtable Column Family.

We can use a ColumnFamily to:

• create itself
• update itself
• delete itself

Parameters

Name	Description
column_family_id	str The ID of the column family. Must be of the form <code>_a-zA-Z0-9][-_.a-zA-Z0-9]</code>*.
table	Table The table that owns the column family.
gc_rule	GarbageCollectionRule (Optional) The garbage collection settings for this column family.

GCRuleIntersection

GCRuleIntersection(rules)

Intersection of garbage collection rules.

For example:

.. literalinclude:: snippets_table.py :start-after: [START bigtable_api_create_family_gc_intersection] :end-before: [END bigtable_api_create_family_gc_intersection] :dedent: 4

Parameter

Name	Description
rules	list List of GarbageCollectionRule.

GCRuleUnion

GCRuleUnion(rules)

Union of garbage collection rules.

For example:

.. literalinclude:: snippets_table.py :start-after: [START bigtable_api_create_family_gc_union] :end-before: [END bigtable_api_create_family_gc_union] :dedent: 4

Parameter

Name	Description
rules	list List of GarbageCollectionRule.

GarbageCollectionRule

GarbageCollectionRule()

Garbage collection rule for column families within a table.

Cells in the column family (within a table) fitting the rule will be deleted during garbage collection.

Note: This class is a do-nothing base class for all GC rules.

A string gc_expression can also be used with API requests, but that value would be superceded by a gc_rule. As a result, we don't support that feature and instead support via native classes.

MaxAgeGCRule

MaxAgeGCRule(max_age)

Garbage collection limiting the age of a cell.

For example:

.. literalinclude:: snippets_table.py :start-after: [START bigtable_api_create_family_gc_max_age] :end-before: [END bigtable_api_create_family_gc_max_age] :dedent: 4

Parameter

Name	Description
max_age	datetime.timedelta The maximum age allowed for a cell in the table.

MaxVersionsGCRule

MaxVersionsGCRule(max_num_versions)

Garbage collection limiting the number of versions of a cell.

For example:

.. literalinclude:: snippets_table.py :start-after: [START bigtable_api_create_family_gc_max_versions] :end-before: [END bigtable_api_create_family_gc_max_versions] :dedent: 4

Parameter

Name	Description
max_num_versions	int The maximum number of versions