Skip to content
This repository was archived by the owner on Apr 1, 2026. It is now read-only.

Commit b5b62c8

Browse files
daniel-sanchedaniel-sanche
authored
feat!: add new v3.0.0 API skeleton (#745)
1 parent 77b5bcd commit b5b62c8

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

76 files changed

+3165
-1329
lines changed

‎.coveragerc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ omit =
2424
google/cloud/bigtable_admin/gapic_version.py
2525

2626
[report]
27-
fail_under = 100
27+
fail_under = 99
2828
show_missing = True
2929
exclude_lines =
3030
# Re-enable the standard pragma

‎docs/app-profile.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
App Profile
22
~~~~~~~~~~~
33

4-
.. automodule:: google.cloud.bigtable.app_profile
4+
.. automodule:: google.cloud.bigtable.deprecated.app_profile
55
:members:
66
:show-inheritance:

‎docs/backup.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Backup
22
~~~~~~~~
33

4-
.. automodule:: google.cloud.bigtable.backup
4+
.. automodule:: google.cloud.bigtable.deprecated.backup
55
:members:
66
:show-inheritance:

‎docs/client-intro.rst‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
11
Base for Everything
22
===================
33

4-
To use the API, the :class:`Client <google.cloud.bigtable.client.Client>`
4+
To use the API, the :class:`Client <google.cloud.bigtable.deprecated.client.Client>`
55
class defines a high-level interface which handles authorization
66
and creating other objects:
77

88
.. code:: python
99
10-
from google.cloud.bigtable.client import Client
10+
from google.cloud.bigtable.deprecated.client import Client
1111
client = Client()
1212
1313
Long-lived Defaults
1414
-------------------
1515

16-
When creating a :class:`Client <google.cloud.bigtable.client.Client>`, the
16+
When creating a :class:`Client <google.cloud.bigtable.deprecated.client.Client>`, the
1717
``user_agent`` argument has sensible a default
18-
(:data:`DEFAULT_USER_AGENT <google.cloud.bigtable.client.DEFAULT_USER_AGENT>`).
18+
(:data:`DEFAULT_USER_AGENT <google.cloud.bigtable.deprecated.client.DEFAULT_USER_AGENT>`).
1919
However, you may over-ride it and the value will be used throughout all API
2020
requests made with the ``client`` you create.
2121

@@ -38,14 +38,14 @@ Configuration
3838

3939
.. code::
4040
41-
>>> from google.cloud import bigtable
41+
>>> import google.cloud.deprecated as bigtable
4242
>>> client = bigtable.Client()
4343
4444
or pass in ``credentials`` and ``project`` explicitly
4545

4646
.. code::
4747
48-
>>> from google.cloud import bigtable
48+
>>> import google.cloud.deprecated as bigtable
4949
>>> client = bigtable.Client(project='my-project', credentials=creds)
5050
5151
.. tip::
@@ -73,15 +73,15 @@ you can pass the ``read_only`` argument:
7373
client = bigtable.Client(read_only=True)
7474
7575
This will ensure that the
76-
:data:`READ_ONLY_SCOPE <google.cloud.bigtable.client.READ_ONLY_SCOPE>` is used
76+
:data:`READ_ONLY_SCOPE <google.cloud.bigtable.deprecated.client.READ_ONLY_SCOPE>` is used
7777
for API requests (so any accidental requests that would modify data will
7878
fail).
7979

8080
Next Step
8181
---------
8282

83-
After a :class:`Client <google.cloud.bigtable.client.Client>`, the next highest-level
84-
object is an :class:`Instance <google.cloud.bigtable.instance.Instance>`. You'll need
83+
After a :class:`Client <google.cloud.bigtable.deprecated.client.Client>`, the next highest-level
84+
object is an :class:`Instance <google.cloud.bigtable.deprecated.instance.Instance>`. You'll need
8585
one before you can interact with tables or data.
8686

8787
Head next to learn about the :doc:`instance-api`.

‎docs/client.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Client
22
~~~~~~
33

4-
.. automodule:: google.cloud.bigtable.client
4+
.. automodule:: google.cloud.bigtable.deprecated.client
55
:members:
66
:show-inheritance:

‎docs/cluster.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Cluster
22
~~~~~~~
33

4-
.. automodule:: google.cloud.bigtable.cluster
4+
.. automodule:: google.cloud.bigtable.deprecated.cluster
55
:members:
66
:show-inheritance:

‎docs/column-family.rst‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,27 +2,27 @@ Column Families
22
===============
33

44
When creating a
5-
:class:`ColumnFamily <google.cloud.bigtable.column_family.ColumnFamily>`, it is
5+
:class:`ColumnFamily <google.cloud.bigtable.deprecated.column_family.ColumnFamily>`, it is
66
possible to set garbage collection rules for expired data.
77

88
By setting a rule, cells in the table matching the rule will be deleted
99
during periodic garbage collection (which executes opportunistically in the
1010
background).
1111

1212
The types
13-
:class:`MaxAgeGCRule <google.cloud.bigtable.column_family.MaxAgeGCRule>`,
14-
:class:`MaxVersionsGCRule <google.cloud.bigtable.column_family.MaxVersionsGCRule>`,
15-
:class:`GarbageCollectionRuleUnion <google.cloud.bigtable.column_family.GarbageCollectionRuleUnion>` and
16-
:class:`GarbageCollectionRuleIntersection <google.cloud.bigtable.column_family.GarbageCollectionRuleIntersection>`
13+
:class:`MaxAgeGCRule <google.cloud.bigtable.deprecated.column_family.MaxAgeGCRule>`,
14+
:class:`MaxVersionsGCRule <google.cloud.bigtable.deprecated.column_family.MaxVersionsGCRule>`,
15+
:class:`GarbageCollectionRuleUnion <google.cloud.bigtable.deprecated.column_family.GarbageCollectionRuleUnion>` and
16+
:class:`GarbageCollectionRuleIntersection <google.cloud.bigtable.deprecated.column_family.GarbageCollectionRuleIntersection>`
1717
can all be used as the optional ``gc_rule`` argument in the
18-
:class:`ColumnFamily <google.cloud.bigtable.column_family.ColumnFamily>`
18+
:class:`ColumnFamily <google.cloud.bigtable.deprecated.column_family.ColumnFamily>`
1919
constructor. This value is then used in the
20-
:meth:`create() <google.cloud.bigtable.column_family.ColumnFamily.create>` and
21-
:meth:`update() <google.cloud.bigtable.column_family.ColumnFamily.update>` methods.
20+
:meth:`create() <google.cloud.bigtable.deprecated.column_family.ColumnFamily.create>` and
21+
:meth:`update() <google.cloud.bigtable.deprecated.column_family.ColumnFamily.update>` methods.
2222

2323
These rules can be nested arbitrarily, with a
24-
:class:`MaxAgeGCRule <google.cloud.bigtable.column_family.MaxAgeGCRule>` or
25-
:class:`MaxVersionsGCRule <google.cloud.bigtable.column_family.MaxVersionsGCRule>`
24+
:class:`MaxAgeGCRule <google.cloud.bigtable.deprecated.column_family.MaxAgeGCRule>` or
25+
:class:`MaxVersionsGCRule <google.cloud.bigtable.deprecated.column_family.MaxVersionsGCRule>`
2626
at the lowest level of the nesting:
2727

2828
.. code:: python
@@ -44,6 +44,6 @@ at the lowest level of the nesting:
4444
4545
----
4646

47-
.. automodule:: google.cloud.bigtable.column_family
47+
.. automodule:: google.cloud.bigtable.deprecated.column_family
4848
:members:
4949
:show-inheritance:

0 commit comments

Comments
 (0)