Skip to content

Commit c13dbca

Browse files
authored
Add async credential provider note (#369)
1 parent 7d53ea0 commit c13dbca

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

docs/authentication.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -129,14 +129,14 @@ There's a long tail of possible authentication mechanisms. Obstore allows you to
129129

130130
You can provide **either a synchronous or asynchronous callback** for your custom authentication function.
131131

132-
!!! note
133-
134-
Provide an asynchronous credential provider for optimal performance.
135-
136132
- A custom AWS credential provider, passed in to [`S3Store`][obstore.store.S3Store] must return an [`S3Credential`][obstore.store.S3Credential].
137133
- A custom GCS credential provider, passed in to [`GCSStore`][obstore.store.GCSStore] must return a [`GCSCredential`][obstore.store.GCSCredential].
138134
- A custom Azure credential provider, passed in to [`AzureStore`][obstore.store.AzureStore] must return an [`AzureCredential`][obstore.store.AzureCredential].
139135

136+
!!! warning
137+
138+
Asynchronous credential providers can be more performant but are only supported when using obstore's asynchronous APIs. (In particular, there must be an event loop running.)
139+
140140
#### Basic Example
141141

142142
The simplest custom credential provider can be just a synchronous or asynchronous function callback:

0 commit comments

Comments
 (0)