Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add Client.delete_job_metadata method to remove job metadata #610

Merged
merged 6 commits into from Apr 26, 2021

Conversation

@tswast
Copy link
Contributor

@tswast tswast commented Apr 14, 2021

Note: this only removes job metadata. Use Client.cancel_job to stop
a running job. Also, this feature is in preview and has not rolled out
to all regions yet

Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:

  • Make sure to open an issue as a bug/issue before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
  • Ensure the tests and linter pass
  • Code coverage does not decrease (if any source code was changed)
  • Appropriate docs were updated (if necessary)

Towards internal issue 176186229 馃

@tswast
Copy link
Contributor Author

@tswast tswast commented Apr 15, 2021

Looks like kokoro is having a rough time. Tests and coverage pass locally.

We'll want to rebase this once #617 merges.

Loading

Note: this only removes job metadata. Use `Client.cancel_job` to stop
a running job. Also, this feature is in preview and has not rolled out
to all regions yet

Location is required, so always pass in location. To keep the method
signature consistent with the other methods, location is not a
positional argument. The location from the job object is preferred.
@tswast tswast marked this pull request as ready for review Apr 20, 2021
@tswast tswast requested a review from as a code owner Apr 20, 2021
@tswast tswast requested review from steffnay and plamut and removed request for and steffnay Apr 20, 2021
tests/system/test_client.py Outdated Show resolved Hide resolved
Loading
plamut
plamut approved these changes Apr 21, 2021
Copy link
Contributor

@plamut plamut left a comment

Looks good.

I just have two nits about string formatting readability improvements, but they are not a blocker.

Loading

google/cloud/bigquery/client.py Outdated Show resolved Hide resolved
Loading
tests/system/test_client.py Outdated Show resolved Hide resolved
Loading
@plamut
Copy link
Contributor

@plamut plamut commented Apr 21, 2021

BTW, the name delete_job() can be misleading unless one reads the docstring, which not all users will do - is the name set in stone, or can it still be changed to, say, delete_job_metadata() to better reflect this fact?

It doesn't really matter if the actual API endpoint is named "delete job", or...?

Loading

tswast and others added 2 commits Apr 23, 2021
Co-authored-by: Peter Lamut <plamut@users.noreply.github.com>
Co-authored-by: Peter Lamut <plamut@users.noreply.github.com>
@tswast
Copy link
Contributor Author

@tswast tswast commented Apr 23, 2021

BTW, the name delete_job() can be misleading unless one reads the docstring, which not all users will do - is the name set in stone, or can it still be changed to, say, delete_job_metadata() to better reflect this fact?

That's a good idea! I agree that it's misleading, which is why I added the docstring note. :-)

Loading

@tswast tswast changed the title feat: add Client.delete_job method to remove job metadata feat: add Client.delete_job_metadata method to remove job metadata Apr 23, 2021
plamut
plamut approved these changes Apr 26, 2021
@plamut
Copy link
Contributor

@plamut plamut commented Apr 26, 2021

Status checks got stuck.

Loading

@gcf-merge-on-green gcf-merge-on-green bot merged commit 0abb566 into googleapis:master Apr 26, 2021
10 checks passed
Loading
gcf-merge-on-green bot pushed a commit that referenced this issue Apr 26, 2021
馃 I have created a release \*beep\* \*boop\*
---
## [2.14.0](https://www.github.com/googleapis/python-bigquery/compare/v2.13.1...v2.14.0) (2021-04-26)


### Features

* accept DatasetListItem where DatasetReference is accepted ([#597](https://www.github.com/googleapis/python-bigquery/issues/597)) ([c8b5581](https://www.github.com/googleapis/python-bigquery/commit/c8b5581ea3c94005d69755c4a3b5a0d8900f3fe2))
* accept job object as argument to `get_job` and `cancel_job` ([#617](https://www.github.com/googleapis/python-bigquery/issues/617)) ([f75dcdf](https://www.github.com/googleapis/python-bigquery/commit/f75dcdf3943b87daba60011c9a3b42e34ff81910))
* add `Client.delete_job_metadata` method to remove job metadata ([#610](https://www.github.com/googleapis/python-bigquery/issues/610)) ([0abb566](https://www.github.com/googleapis/python-bigquery/commit/0abb56669c097c59fbffce007c702e7a55f2d9c1))
* add `max_queue_size` argument to `RowIterator.to_dataframe_iterable` ([#575](https://www.github.com/googleapis/python-bigquery/issues/575)) ([f95f415](https://www.github.com/googleapis/python-bigquery/commit/f95f415d3441b3928f6cc705cb8a75603d790fd6))
* add type hints for public methods ([#613](https://www.github.com/googleapis/python-bigquery/issues/613)) ([f8d4aaa](https://www.github.com/googleapis/python-bigquery/commit/f8d4aaa335a0eef915e73596fc9b43b11d11be9f))
* DB API cursors are now iterable ([#618](https://www.github.com/googleapis/python-bigquery/issues/618)) ([e0b373d](https://www.github.com/googleapis/python-bigquery/commit/e0b373d0e721a70656ed8faceb7f5c70f642d144))
* retry google.auth TransportError by default ([#624](https://www.github.com/googleapis/python-bigquery/issues/624)) ([34ecc3f](https://www.github.com/googleapis/python-bigquery/commit/34ecc3f1ca0ff073330c0c605673d89b43af7ed9))
* use pyarrow stream compression, if available ([#593](https://www.github.com/googleapis/python-bigquery/issues/593)) ([dde9dc5](https://www.github.com/googleapis/python-bigquery/commit/dde9dc5114c2311fb76fafc5b222fff561e8abf1))


### Bug Fixes

* consistent percents handling in DB API query ([#619](https://www.github.com/googleapis/python-bigquery/issues/619)) ([6502a60](https://www.github.com/googleapis/python-bigquery/commit/6502a602337ae562652a20b20270949f2c9d5073))
* missing license headers in new test files ([#604](https://www.github.com/googleapis/python-bigquery/issues/604)) ([df48cc5](https://www.github.com/googleapis/python-bigquery/commit/df48cc5a0be99ad39d5835652d1b7422209afc5d))
* unsetting clustering fileds on Table is now possible ([#622](https://www.github.com/googleapis/python-bigquery/issues/622)) ([33a871f](https://www.github.com/googleapis/python-bigquery/commit/33a871f06329f9bf5a6a92fab9ead65bf2bee75d))


### Documentation

* add sample to run DML query ([#591](https://www.github.com/googleapis/python-bigquery/issues/591)) ([ff2ec3a](https://www.github.com/googleapis/python-bigquery/commit/ff2ec3abe418a443cd07751c08e654f94e8b3155))
* update the description of the return value of `_QueryResults.rows()` ([#594](https://www.github.com/googleapis/python-bigquery/issues/594)) ([8f4c0b8](https://www.github.com/googleapis/python-bigquery/commit/8f4c0b84dac3840532d7865247b8ad94b625b897))
---


This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

3 participants