From 5ad60a10362ec295d05c17be77f7b2390f0584e9 Mon Sep 17 00:00:00 2001 From: Kyle Barron Date: Mon, 17 Mar 2025 12:44:24 -0400 Subject: [PATCH] Add async credential provider note --- docs/authentication.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/authentication.md b/docs/authentication.md index cb94c7fe..b52ee9ab 100644 --- a/docs/authentication.md +++ b/docs/authentication.md @@ -129,14 +129,14 @@ There's a long tail of possible authentication mechanisms. Obstore allows you to You can provide **either a synchronous or asynchronous callback** for your custom authentication function. -!!! note - - Provide an asynchronous credential provider for optimal performance. - - A custom AWS credential provider, passed in to [`S3Store`][obstore.store.S3Store] must return an [`S3Credential`][obstore.store.S3Credential]. - A custom GCS credential provider, passed in to [`GCSStore`][obstore.store.GCSStore] must return a [`GCSCredential`][obstore.store.GCSCredential]. - A custom Azure credential provider, passed in to [`AzureStore`][obstore.store.AzureStore] must return an [`AzureCredential`][obstore.store.AzureCredential]. +!!! warning + + 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.) + #### Basic Example The simplest custom credential provider can be just a synchronous or asynchronous function callback: