Skip to content

Documenting length limits and cost of creating Admin and Client objects - #1177

Merged
coryan merged 2 commits into
googleapis:masterfrom
manish-qlogic:document_limits_cost_for_bigtable_client
Sep 28, 2018
Merged

coryan merged 2 commits into
googleapis:masterfrom
manish-qlogic:document_limits_cost_for_bigtable_client

Conversation

@manish-qlogic

@manish-qlogic manish-qlogic commented Sep 26, 2018 •

Copy link
Copy Markdown
Contributor

Documenting instance id, name and cluster id length limits and cost of creating admin and clients objects.

This fixes #802 and #480


This change is Reviewable

@googlebot googlebot added the cla: yes This human has signed the Contributor License Agreement. label Sep 26, 2018
@codecov

codecov Bot commented Sep 26, 2018 •

Copy link
Copy Markdown

Codecov Report

Merging #1177 into master will increase coverage by 0.01%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #1177      +/-   ##
==========================================
+ Coverage   91.93%   91.94%   +0.01%     
==========================================
  Files         220      220              
  Lines       12169    12197      +28     
==========================================
+ Hits        11188    11215      +27     
- Misses        981      982       +1
Impacted Files Coverage Δ
google/cloud/bigtable/table_admin.h 100% <ø> (ø) ⬆️
google/cloud/bigtable/instance_admin.h 100% <ø> (ø) ⬆️
google/cloud/bigtable/admin_client.h 100% <ø> (ø) ⬆️
google/cloud/bigtable/data_client.h 100% <ø> (ø) ⬆️
google/cloud/bigtable/instance_admin_client.h 100% <ø> (ø) ⬆️
google/cloud/bigtable/table.h 100% <ø> (ø) ⬆️
google/cloud/storage/internal/curl_client.cc 83.4% <0%> (-0.06%) ⬇️
google/cloud/storage/internal/curl_client.h 100% <0%> (ø) ⬆️
google/cloud/storage/client_options.h 90.32% <0%> (+0.66%) ⬆️
... and 2 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 2cdb7e3...4026edc. Read the comment docs.

@sduskis sduskis added the api: bigtable Issues related to the Bigtable API. label Sep 26, 2018

@coryan coryan left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lots of nits about code formatting and avoiding some repetition. Otherwise good.

Comment thread google/cloud/bigtable/admin_client.h Outdated
*
* @par Cost
* Applications should avoid unnecessarily creating new objects of type
* AdminClient. Creating a new object of this type typically requires connecting

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please you use AdminClient make it look like code in the docs.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed.

Comment thread google/cloud/bigtable/instance_admin.h Outdated
*
* @par Cost
* Creating a new object of type InstanceAdmin is comparable to creating a few
* objects of type std::string or a few objects of type std::shared_ptr<int>.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same thing here about formatting.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed.

Comment thread google/cloud/bigtable/instance_admin.h Outdated
*
* @param instance_config a description of the new instance to be created.
* instance_id and a display_name parameters must be set in instance_config,
* - instance_id : instance_id must be between 6 and 33 characters.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we can just say:

 * - instance_id : must be between 6 and 33 characters.

no need to repeat instance_id, sample thing with display_name.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed.

Comment thread google/cloud/bigtable/table.h Outdated
*
* @par Cost
* Creating a new object of type Table is comparable to creating a few objects
* of type std::string or a few objects of type std::shared_ptr<int>. The class

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same comment about code formatting.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed

@manish-qlogic

Copy link
Copy Markdown
Contributor Author

PTAL

@coryan coryan added the kokoro:run Add this label to force Kokoro to re-run the tests. label Sep 28, 2018
@kokoro-team kokoro-team removed the kokoro:run Add this label to force Kokoro to re-run the tests. label Sep 28, 2018
@coryan
coryan merged commit 00aebad into googleapis:master Sep 28, 2018
@manish-qlogic
manish-qlogic deleted the document_limits_cost_for_bigtable_client branch October 2, 2018 12:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

api: bigtable Issues related to the Bigtable API. cla: yes This human has signed the Contributor License Agreement.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document which objects are "expensive" to create.

5 participants