You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/authentication.md
+4-4Lines changed: 4 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -129,14 +129,14 @@ There's a long tail of possible authentication mechanisms. Obstore allows you to
129
129
130
130
You can provide **either a synchronous or asynchronous callback** for your custom authentication function.
131
131
132
-
!!! note
133
-
134
-
Provide an asynchronous credential provider for optimal performance.
135
-
136
132
- A custom AWS credential provider, passed in to [`S3Store`][obstore.store.S3Store] must return an [`S3Credential`][obstore.store.S3Credential].
137
133
- A custom GCS credential provider, passed in to [`GCSStore`][obstore.store.GCSStore] must return a [`GCSCredential`][obstore.store.GCSCredential].
138
134
- A custom Azure credential provider, passed in to [`AzureStore`][obstore.store.AzureStore] must return an [`AzureCredential`][obstore.store.AzureCredential].
139
135
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
+
140
140
#### Basic Example
141
141
142
142
The simplest custom credential provider can be just a synchronous or asynchronous function callback:
0 commit comments