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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Expose retry, timeout parameters in manual surface #221

Closed
crwilcox opened this issue Oct 9, 2020 · 1 comment · Fixed by #222
Closed

Expose retry, timeout parameters in manual surface #221

crwilcox opened this issue Oct 9, 2020 · 1 comment · Fixed by #222
Assignees
@tseaver
Labels
help wanted We'd love to have community involvement on this issue. type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design.

Comments

@crwilcox
Copy link
Contributor

crwilcox commented Oct 9, 2020

the generated surface surfaces retry and timeout. For many calls this would be useful for firestore customers.

def run_query(
        self,
        request: firestore.RunQueryRequest = None,
        *,
        retry: retries.Retry = gapic_v1.method.DEFAULT,
        timeout: float = None,
        metadata: Sequence[Tuple[str, str]] = (),
    ) -> Iterable[firestore.RunQueryResponse]:

Async and Sync clients should be updated to expose this.
@product-auto-label product-auto-label bot added the api: firestore Issues related to the googleapis/python-firestore API. label Oct 9, 2020
@crwilcox crwilcox added help wanted We'd love to have community involvement on this issue. type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design. and removed api: firestore Issues related to the googleapis/python-firestore API. labels Oct 9, 2020
@tseaver tseaver self-assigned this Oct 13, 2020
tseaver added a commit that referenced this issue Oct 13, 2020
@tseaver
feat: add retry/timeout to 'client.Client.get_all'
1b61f49 
Toward #221
@tseaver tseaver mentioned this issue Oct 13, 2020
Merged
53 tasks
tseaver added a commit that referenced this issue Oct 13, 2020
@tseaver
feat: add retry/timeout to 'client.Client.get_all'
8d03921 
Toward #221
tseaver added a commit that referenced this issue Oct 13, 2020
@tseaver
feat: add retry/timeout to 'client.Client.collections'
e7d2119 
Toward #221
tseaver added a commit that referenced this issue Oct 13, 2020
@tseaver
feat: add retry/timeout to 'batch.Batch.commit'
6bfe32f 
Toward #221
tseaver added a commit that referenced this issue Oct 13, 2020
@tseaver
feat: add retry/timeout to 'document.Document.get'
4ab004b 
Toward #221
tseaver added a commit that referenced this issue Oct 13, 2020
@tseaver
feat: add retry/timeout to 'document.Document.collections'
19ddd52 
Toward #221
tseaver added a commit that referenced this issue Oct 13, 2020
@tseaver
feat: add retry/timeout to 'document.Document.delete'
bf1d084 
Toward #221
tseaver added a commit that referenced this issue Oct 13, 2020
@tseaver
feat: add retry/timeout to 'document.Document.create'
58ca931 
Toward #221
tseaver added a commit that referenced this issue Oct 13, 2020
@tseaver
feat: add retry/timeout to 'document.Document.set'
61f07ce 
Toward #221
tseaver added a commit that referenced this issue Oct 13, 2020
@tseaver
feat: add retry/timeout to 'document.Document.update'
385ebfb 
Toward #221
tseaver added a commit that referenced this issue Oct 13, 2020
@tseaver
feat: add retry/timeout to 'query.Query.stream'
2ffa695 
Toward #221
tseaver added a commit that referenced this issue Oct 13, 2020
@tseaver
feat: add retry/timeout to 'query.Query.get'
84fd058 
Toward #221
tseaver added a commit that referenced this issue Oct 13, 2020
@tseaver
feat: add retry/timeout to 'query.CollectionGroup.get_partitions'
07aa854 
Toward #221
tseaver added a commit that referenced this issue Oct 13, 2020
@tseaver
feat: add retry/timeout to 'document.DocumentReference.get'
6ba6d21 
Toward #221
tseaver added a commit that referenced this issue Oct 13, 2020
@tseaver
feat: add retry/timeout to 'document.DocumentReference.collections'
a9547e6 
Toward #221
tseaver added a commit that referenced this issue Oct 13, 2020
@tseaver
feat: add retry/timeout to 'document.DocumentReference.delete'
d6df19c 
Toward #221
tseaver added a commit that referenced this issue Oct 13, 2020
@tseaver
feat: add retry/timeout to 'document.DocumentReference.create'
6eae0e7 
Toward #221
tseaver added a commit that referenced this issue Oct 13, 2020
@tseaver
feat: add retry/timeout to 'document.DocumentReference.set'
559f2eb 
Toward #221
tseaver added a commit that referenced this issue Oct 13, 2020
@tseaver
feat: add retry/timeout to 'document.DocumentReference.update'
8038cce 
Toward #221
tseaver added a commit that referenced this issue Oct 13, 2020
@tseaver
feat: add retry/timeout to 'query.Query.stream'
2d413df 
Toward #221
tseaver added a commit that referenced this issue Oct 13, 2020
@tseaver
feat: add retry/timeout to 'query.Query.get'
e6ad4a1 
Toward #221
tseaver added a commit that referenced this issue Oct 13, 2020
@tseaver
feat: add retry/timeout to 'query.CollectionGroup.get_partitions'
6e806b0 
Toward #221
tseaver added a commit that referenced this issue Oct 13, 2020
@tseaver
feat: add retry/timeout to 'collection.CollectionReference.add'
00736fe 
Toward #221
tseaver added a commit that referenced this issue Oct 13, 2020
@tseaver
feat: add retry/timeout to 'collection.CollectionReference.list_docum…
2b80b91 
…ents'

Toward #221
tseaver added a commit that referenced this issue Oct 13, 2020
@tseaver
feat: add retry/timeout to 'collection.CollectionReference.get'
49d3b03 
Toward #221
tseaver added a commit that referenced this issue Oct 13, 2020
@tseaver
feat: add retry/timeout to 'collection.CollectionReference.stream'
16a1e34 
Toward #221
@tseaver
Copy link
Contributor

tseaver commented Oct 13, 2020 •
edited

@crwilcox API design questions:

  • How should retry and timeout options be surfaced when using Batch or Transaction as context managers?
  • Should the normally-invisible Transaction._begin and Transaction._rollback methods somehow pass through retry / timeout?
  • How should retry / timeout be exposed / plumbed through for DocumentReference.on_snapshot (likewise CollectionReference.on_snapshot and Query.on_snapshot)?

tseaver added a commit that referenced this issue Oct 13, 2020
@tseaver
feat: add retry/timeout to 'transaction.Transaction.get_all'
e15b8f6 
Toward #221
tseaver added a commit that referenced this issue Oct 13, 2020
@tseaver
feat: add retry/timeout to 'transaction.Transaction.get'
9f5bbb4 
Toward #221
tseaver added a commit that referenced this issue Oct 13, 2020
@tseaver
feat: add retry/timeout to base class signatures
5a1ef50 
Toward #221
tseaver added a commit that referenced this issue Oct 14, 2020
@tseaver
feat: add retry/timeout to 'async_client.AsyncClient.{collections.get…
db01b59 
…_all}'

Toward #221
tseaver added a commit that referenced this issue Oct 14, 2020
@tseaver
feat: add retry/timeout to 'async_batch.AsyncBatch.commit'
a557a15 
Toward #221
tseaver added a commit that referenced this issue Oct 14, 2020
@tseaver
feat: add retry/timeout to 'async_document.AsyncDocument.{delete,get,…
d6e76d6 
…collections}

Toward #221
tseaver added a commit that referenced this issue Oct 14, 2020
@tseaver
feat: add retry/timeout to 'async_document.AsyncDocument` methods
4e3be50 
Methods include:

- 'create'
- 'set'
- 'update'
- 'delete'
- 'get'
- 'collections'

Toward #221
tseaver added a commit that referenced this issue Oct 14, 2020
@tseaver
feat: add retry/timeout to 'async_query.Async{Query,CollectionGroup}'
ec8002c 
Methods affected:

- 'AsyncQuery.get'
- 'AsyncQuery.stream'
- 'AsyncCollectionGroup.get_partitions'

Towards #221
tseaver added a commit that referenced this issue Oct 14, 2020
@tseaver
feat: add retry/timeout to 'async_collection.AsyncCollectionReference'
c81cd8c 
Methods affected:

- 'add'
- 'get'
- 'list_documents'
- 'stream'

Towards #221
tseaver added a commit that referenced this issue Oct 14, 2020
@tseaver
feat: add retry/timeout to 'async_transaction.AsyncTransaction' methods
46f27e6 
Methods affected:

- 'get_all'
- 'get'

Towards #221
tseaver added a commit that referenced this issue Oct 21, 2020
@tseaver
feat: add retry/timeout to manual surface (#222)
db5f286 
Closes #221
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@tseaver tseaver

Labels
help wanted We'd love to have community involvement on this issue. type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat: add retry/timeout to manual surface googleapis/python-firestore
2 participants
@tseaver @crwilcox