feat(export): introduce StorageBackend shared base for backup/export backends

mpartipilo · claude · mpartipilo · commit 96080d887c62 · 2026-04-28T12:35:20.000+02:00
Reviewer (#dirkkul) asked for the backend choices to be discoverable from
the export API and for the Backup and Export sub-clients to feel
consistent in use. Introduce a shared abstract base record that both
features inherit from, so:

- typing 'ExportBackend.' surfaces Filesystem/S3/GCS/Azure factories from
  the export entry point (mirrors the existing factories on BackupBackend);
- export-typed variables can be declared as 'StorageBackend' instead of
  the misleading 'BackupBackend';
- the same concrete backend types (FilesystemBackend, ObjectStorageBackend)
  flow through both BackupClient and ExportClient unchanged.

Changes:
- New: 'public abstract record StorageBackend' in Models/StorageBackend.cs
  carrying the abstract Provider/Path contract that previously lived on
  BackupBackend.
- Existing: 'BackupBackend : StorageBackend' — abstract members now
  inherited from StorageBackend; static factories unchanged. Concrete
  FilesystemBackend / ObjectStorageBackend / EmptyBackend continue to
  derive from BackupBackend, so existing callers compile and behave
  identically (backwards compatible).
- New: 'public abstract record ExportBackend : StorageBackend' with
  static Filesystem / S3 / GCS / Azure factories that delegate to
  BackupBackend's and return StorageBackend.
- Widen export-side API to StorageBackend (export feature is new in this
  PR, no consumer impact): ExportCreateRequest.Backend, Export.Backend,
  ExportClient.GetStatus / Cancel parameters, ParseBackend return.

Backwards compatibility:
- BackupCreateRequest.Backend stays BackupBackend.
- All concrete backend types still derive from BackupBackend.
- BackupBackend.Provider / Path remain accessible (inherited from
  StorageBackend) — 'is BackupBackend' / 'as BackupBackend' checks
  on FilesystemBackend / ObjectStorageBackend keep working.
- All factories on BackupBackend keep their original return types.

Co-Authored-By: Claude Opus 4.7 (1M context) &lt;noreply@anthropic.com&gt;
diff --git a/src/Weaviate.Client/ExportClient.cs b/src/Weaviate.Client/ExportClient.cs
@@ -79,7 +79,7 @@ public async Task<Export> CreateSync(
     /// </summary>
     [RequiresWeaviateVersion(1, 37, 0)]
     public async Task<Export> GetStatus(
-        BackupBackend backend,
+        StorageBackend backend,
         string id,
         CancellationToken cancellationToken = default
     )
@@ -102,7 +102,7 @@ public async Task<Export> GetStatus(
     /// </summary>
     [RequiresWeaviateVersion(1, 37, 0)]
     public async Task<bool> Cancel(
-        BackupBackend backend,
+        StorageBackend backend,
         string id,
         CancellationToken cancellationToken = default
     )
@@ -141,7 +141,7 @@ private static Export ToModel(Rest.Dto.ExportCreateResponse dto) =>
             null
         );
 
-    private static Export ToModel(Rest.Dto.ExportStatusResponse dto, BackupBackend backend) =>
+    private static Export ToModel(Rest.Dto.ExportStatusResponse dto, StorageBackend backend) =>
         new(
             dto.Id ?? string.Empty,
             backend,
@@ -169,7 +169,7 @@ private static Export ToModel(Rest.Dto.ExportStatusResponse dto, BackupBackend b
             TookInMs = dto.TookInMs.HasValue ? (int)dto.TookInMs.Value : null,
         };
 
-    private static BackupBackend ParseBackend(string? backendStr)
+    private static StorageBackend ParseBackend(string? backendStr)
     {
         var provider = backendStr?.ToLowerInvariant() switch
         {
diff --git a/src/Weaviate.Client/Models/Backup.cs b/src/Weaviate.Client/Models/Backup.cs
@@ -131,20 +131,13 @@ public enum BackupStorageProvider
 }
 
 /// <summary>
-/// Base class for backup backend configurations
+/// Backup-feature view of a storage backend. Inherits the abstract
+/// <see cref="StorageBackend.Provider"/> / <see cref="StorageBackend.Path"/> contract
+/// from <see cref="StorageBackend"/>, and exposes static factories that return
+/// <see cref="BackupBackend"/> for use with <see cref="BackupClient"/>.
 /// </summary>
-public abstract record BackupBackend
+public abstract record BackupBackend : StorageBackend
 {
-    /// <summary>
-    /// The backend storage provider
-    /// </summary>
-    public abstract BackupStorageProvider Provider { get; }
-
-    /// <summary>
-    /// Optional path for the backup location
-    /// </summary>
-    public abstract string? Path { get; }
-
     /// <summary>
     /// Creates an empty backend (no backend specified)
     /// </summary>
diff --git a/src/Weaviate.Client/Models/Export.cs b/src/Weaviate.Client/Models/Export.cs
@@ -79,7 +79,7 @@ public static ExportStatus ToExportStatus(this string? status)
 /// </summary>
 public record Export(
     string Id,
-    BackupBackend Backend,
+    StorageBackend Backend,
     string? Path,
     string StatusRaw,
     string[]? Collections,
@@ -119,8 +119,34 @@ public record ShardProgress(
 /// </summary>
 public record ExportCreateRequest(
     string Id,
-    BackupBackend Backend,
+    StorageBackend Backend,
     ExportFileFormat FileFormat,
     AutoArray<string>? IncludeCollections = null,
     AutoArray<string>? ExcludeCollections = null
 );
+
+/// <summary>
+/// Export-feature view of a storage backend. Inherits the abstract
+/// <see cref="StorageBackend.Provider"/> / <see cref="StorageBackend.Path"/> contract
+/// from <see cref="StorageBackend"/>, and exposes static factories under an
+/// export-themed name so the backend choices are discoverable through the export API.
+/// Each factory delegates to the matching <see cref="BackupBackend"/> factory —
+/// exports and backups share the same concrete backend types underneath.
+/// </summary>
+public abstract record ExportBackend : StorageBackend
+{
+    /// <summary>Creates a filesystem export backend.</summary>
+    public static StorageBackend Filesystem(string? path = null) => BackupBackend.Filesystem(path);
+
+    /// <summary>Creates an S3 export backend.</summary>
+    public static StorageBackend S3(string? bucket = null, string? path = null) =>
+        BackupBackend.S3(bucket, path);
+
+    /// <summary>Creates a GCS export backend.</summary>
+    public static StorageBackend GCS(string? bucket = null, string? path = null) =>
+        BackupBackend.GCS(bucket, path);
+
+    /// <summary>Creates an Azure export backend.</summary>
+    public static StorageBackend Azure(string? bucket = null, string? path = null) =>
+        BackupBackend.Azure(bucket, path);
+}
diff --git a/src/Weaviate.Client/Models/StorageBackend.cs b/src/Weaviate.Client/Models/StorageBackend.cs
@@ -0,0 +1,23 @@
+namespace Weaviate.Client.Models;
+
+/// <summary>
+/// Shared base for storage backend configurations used by Weaviate sub-clients that
+/// persist data to external storage (backup, export, …). Concrete subtypes
+/// (<see cref="FilesystemBackend"/>, <see cref="ObjectStorageBackend"/>, …) describe a
+/// specific storage location; the per-feature abstract types <see cref="BackupBackend"/>
+/// and <see cref="ExportBackend"/> serve as discoverable factory namespaces with
+/// feature-appropriate naming, and inherit from this type so the same concrete instances
+/// can be passed to either feature's API.
+/// </summary>
+public abstract record StorageBackend
+{
+    /// <summary>
+    /// The backend storage provider (filesystem, S3, GCS, Azure, …).
+    /// </summary>
+    public abstract BackupStorageProvider Provider { get; }
+
+    /// <summary>
+    /// Optional path within the storage location.
+    /// </summary>
+    public abstract string? Path { get; }
+}
diff --git a/src/Weaviate.Client/PublicAPI.Unshipped.txt b/src/Weaviate.Client/PublicAPI.Unshipped.txt
@@ -8,9 +8,6 @@ Weaviate.Client.Batch.TaskHandle.Status.get -> Weaviate.Client.Batch.BatchObject
 
 abstract Weaviate.Client.Models.Aggregate.Metric.<Clone>$() -> Weaviate.Client.Models.Aggregate.Metric!
 abstract Weaviate.Client.Models.Aggregate.Property.<Clone>$() -> Weaviate.Client.Models.Aggregate.Property!
-abstract Weaviate.Client.Models.BackupBackend.<Clone>$() -> Weaviate.Client.Models.BackupBackend!
-abstract Weaviate.Client.Models.BackupBackend.Path.get -> string?
-abstract Weaviate.Client.Models.BackupBackend.Provider.get -> Weaviate.Client.Models.BackupStorageProvider
 abstract Weaviate.Client.Models.BM25Operator.<Clone>$() -> Weaviate.Client.Models.BM25Operator!
 abstract Weaviate.Client.Models.CollectionConfigCommon.<Clone>$() -> Weaviate.Client.Models.CollectionConfigCommon!
 abstract Weaviate.Client.Models.GenerativeConfig.OpenAIBase.<Clone>$() -> Weaviate.Client.Models.GenerativeConfig.OpenAIBase!
@@ -2148,9 +2145,7 @@ virtual Weaviate.Client.Models.Backup.<Clone>$() -> Weaviate.Client.Models.Backu
 virtual Weaviate.Client.Models.Backup.EqualityContract.get -> System.Type!
 virtual Weaviate.Client.Models.Backup.Equals(Weaviate.Client.Models.Backup? other) -> bool
 virtual Weaviate.Client.Models.Backup.PrintMembers(System.Text.StringBuilder! builder) -> bool
-virtual Weaviate.Client.Models.BackupBackend.EqualityContract.get -> System.Type!
 virtual Weaviate.Client.Models.BackupBackend.Equals(Weaviate.Client.Models.BackupBackend? other) -> bool
-virtual Weaviate.Client.Models.BackupBackend.PrintMembers(System.Text.StringBuilder! builder) -> bool
 virtual Weaviate.Client.Models.BackupClientConfig.<Clone>$() -> Weaviate.Client.Models.BackupClientConfig!
 virtual Weaviate.Client.Models.BackupClientConfig.EqualityContract.get -> System.Type!
 virtual Weaviate.Client.Models.BackupClientConfig.Equals(Weaviate.Client.Models.BackupClientConfig? other) -> bool
@@ -2936,10 +2931,8 @@ Weaviate.Client.DefaultTokenServiceFactory.CreateAsync(Weaviate.Client.ClientCon
 Weaviate.Client.DefaultTokenServiceFactory.CreateSync(Weaviate.Client.ClientConfiguration! configuration) -> Weaviate.Client.ITokenService?
 Weaviate.Client.DefaultTokenServiceFactory.DefaultTokenServiceFactory() -> void
 Weaviate.Client.ExportClient
-Weaviate.Client.ExportClient.Cancel(Weaviate.Client.Models.BackupBackend! backend, string! id, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task<bool>!
 Weaviate.Client.ExportClient.Create(Weaviate.Client.Models.ExportCreateRequest! request, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task<Weaviate.Client.Models.ExportOperation!>!
 Weaviate.Client.ExportClient.CreateSync(Weaviate.Client.Models.ExportCreateRequest! request, System.TimeSpan? timeout = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task<Weaviate.Client.Models.Export!>!
-Weaviate.Client.ExportClient.GetStatus(Weaviate.Client.Models.BackupBackend! backend, string! id, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task<Weaviate.Client.Models.Export!>!
 Weaviate.Client.DependencyInjection.IWeaviateClientFactory
 Weaviate.Client.DependencyInjection.IWeaviateClientFactory.GetClient(string! name) -> Weaviate.Client.WeaviateClient!
 Weaviate.Client.DependencyInjection.IWeaviateClientFactory.GetClientAsync(string! name, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task<Weaviate.Client.WeaviateClient!>!
@@ -3703,17 +3696,14 @@ Weaviate.Client.Models.DeletionStrategy.TimeBasedResolution = 2 -> Weaviate.Clie
 Weaviate.Client.Models.EmptyStringEnumConverter<T>
 Weaviate.Client.Models.EmptyStringEnumConverter<T>.EmptyStringEnumConverter() -> void
 Weaviate.Client.Models.Export
-Weaviate.Client.Models.Export.Backend.get -> Weaviate.Client.Models.BackupBackend!
 Weaviate.Client.Models.Export.Backend.init -> void
 Weaviate.Client.Models.Export.Collections.get -> string![]?
 Weaviate.Client.Models.Export.Collections.init -> void
 Weaviate.Client.Models.Export.CompletedAt.get -> System.DateTimeOffset?
 Weaviate.Client.Models.Export.CompletedAt.init -> void
-Weaviate.Client.Models.Export.Deconstruct(out string! Id, out Weaviate.Client.Models.BackupBackend! Backend, out string? Path, out string! StatusRaw, out string![]? Collections, out System.DateTimeOffset? StartedAt, out System.DateTimeOffset? CompletedAt, out string? Error) -> void
 Weaviate.Client.Models.Export.Error.get -> string?
 Weaviate.Client.Models.Export.Error.init -> void
 Weaviate.Client.Models.Export.Export(Weaviate.Client.Models.Export! original) -> void
-Weaviate.Client.Models.Export.Export(string! Id, Weaviate.Client.Models.BackupBackend! Backend, string? Path, string! StatusRaw, string![]? Collections, System.DateTimeOffset? StartedAt, System.DateTimeOffset? CompletedAt, string? Error) -> void
 Weaviate.Client.Models.Export.Path.get -> string?
 Weaviate.Client.Models.Export.Path.init -> void
 Weaviate.Client.Models.Export.Id.get -> string!
@@ -3735,13 +3725,10 @@ Weaviate.Client.Models.ExportClientConfig.PollInterval.init -> void
 Weaviate.Client.Models.ExportClientConfig.Timeout.get -> System.TimeSpan
 Weaviate.Client.Models.ExportClientConfig.Timeout.init -> void
 Weaviate.Client.Models.ExportCreateRequest
-Weaviate.Client.Models.ExportCreateRequest.Backend.get -> Weaviate.Client.Models.BackupBackend!
 Weaviate.Client.Models.ExportCreateRequest.Backend.init -> void
-Weaviate.Client.Models.ExportCreateRequest.Deconstruct(out string! Id, out Weaviate.Client.Models.BackupBackend! Backend, out Weaviate.Client.Models.ExportFileFormat FileFormat, out Weaviate.Client.Internal.AutoArray<string!>? IncludeCollections, out Weaviate.Client.Internal.AutoArray<string!>? ExcludeCollections) -> void
 Weaviate.Client.Models.ExportCreateRequest.ExcludeCollections.get -> Weaviate.Client.Internal.AutoArray<string!>?
 Weaviate.Client.Models.ExportCreateRequest.ExcludeCollections.init -> void
 Weaviate.Client.Models.ExportCreateRequest.ExportCreateRequest(Weaviate.Client.Models.ExportCreateRequest! original) -> void
-Weaviate.Client.Models.ExportCreateRequest.ExportCreateRequest(string! Id, Weaviate.Client.Models.BackupBackend! Backend, Weaviate.Client.Models.ExportFileFormat FileFormat, Weaviate.Client.Internal.AutoArray<string!>? IncludeCollections = null, Weaviate.Client.Internal.AutoArray<string!>? ExcludeCollections = null) -> void
 Weaviate.Client.Models.ExportCreateRequest.FileFormat.get -> Weaviate.Client.Models.ExportFileFormat
 Weaviate.Client.Models.ExportCreateRequest.FileFormat.init -> void
 Weaviate.Client.Models.ExportCreateRequest.Id.get -> string!
@@ -6952,3 +6939,46 @@ Weaviate.Client.DependencyInjection.WeaviateOptions.AddIntegration(string! integ
 Weaviate.Client.ClientConfigurationExtensions
 static Weaviate.Client.ClientConfigurationExtensions.WithIntegration(this Weaviate.Client.ClientConfiguration! config, string! integrationValue) -> Weaviate.Client.ClientConfiguration!
 static Weaviate.Client.WeaviateClientBuilderExtensions.WithIntegration(this Weaviate.Client.WeaviateClientBuilder! builder, string! integrationValue) -> Weaviate.Client.WeaviateClientBuilder!
+Weaviate.Client.ExportClient.Cancel(Weaviate.Client.Models.StorageBackend! backend, string! id, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task<bool>!
+Weaviate.Client.ExportClient.GetStatus(Weaviate.Client.Models.StorageBackend! backend, string! id, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task<Weaviate.Client.Models.Export!>!
+Weaviate.Client.Models.Export.Backend.get -> Weaviate.Client.Models.StorageBackend!
+Weaviate.Client.Models.Export.Deconstruct(out string! Id, out Weaviate.Client.Models.StorageBackend! Backend, out string? Path, out string! StatusRaw, out string![]? Collections, out System.DateTimeOffset? StartedAt, out System.DateTimeOffset? CompletedAt, out string? Error) -> void
+Weaviate.Client.Models.Export.Export(string! Id, Weaviate.Client.Models.StorageBackend! Backend, string? Path, string! StatusRaw, string![]? Collections, System.DateTimeOffset? StartedAt, System.DateTimeOffset? CompletedAt, string? Error) -> void
+Weaviate.Client.Models.ExportBackend
+Weaviate.Client.Models.ExportBackend.ExportBackend() -> void
+Weaviate.Client.Models.ExportBackend.ExportBackend(Weaviate.Client.Models.ExportBackend! original) -> void
+Weaviate.Client.Models.ExportCreateRequest.Backend.get -> Weaviate.Client.Models.StorageBackend!
+Weaviate.Client.Models.ExportCreateRequest.Deconstruct(out string! Id, out Weaviate.Client.Models.StorageBackend! Backend, out Weaviate.Client.Models.ExportFileFormat FileFormat, out Weaviate.Client.Internal.AutoArray<string!>? IncludeCollections, out Weaviate.Client.Internal.AutoArray<string!>? ExcludeCollections) -> void
+Weaviate.Client.Models.ExportCreateRequest.ExportCreateRequest(string! Id, Weaviate.Client.Models.StorageBackend! Backend, Weaviate.Client.Models.ExportFileFormat FileFormat, Weaviate.Client.Internal.AutoArray<string!>? IncludeCollections = null, Weaviate.Client.Internal.AutoArray<string!>? ExcludeCollections = null) -> void
+Weaviate.Client.Models.StorageBackend
+Weaviate.Client.Models.StorageBackend.StorageBackend() -> void
+Weaviate.Client.Models.StorageBackend.StorageBackend(Weaviate.Client.Models.StorageBackend! original) -> void
+abstract Weaviate.Client.Models.StorageBackend.<Clone>$() -> Weaviate.Client.Models.StorageBackend!
+abstract Weaviate.Client.Models.StorageBackend.Path.get -> string?
+abstract Weaviate.Client.Models.StorageBackend.Provider.get -> Weaviate.Client.Models.BackupStorageProvider
+override Weaviate.Client.Models.BackupBackend.EqualityContract.get -> System.Type!
+override Weaviate.Client.Models.BackupBackend.PrintMembers(System.Text.StringBuilder! builder) -> bool
+override Weaviate.Client.Models.ExportBackend.EqualityContract.get -> System.Type!
+override Weaviate.Client.Models.ExportBackend.Equals(object? obj) -> bool
+override Weaviate.Client.Models.ExportBackend.GetHashCode() -> int
+override Weaviate.Client.Models.ExportBackend.PrintMembers(System.Text.StringBuilder! builder) -> bool
+override Weaviate.Client.Models.ExportBackend.ToString() -> string!
+override Weaviate.Client.Models.StorageBackend.Equals(object? obj) -> bool
+override Weaviate.Client.Models.StorageBackend.GetHashCode() -> int
+override Weaviate.Client.Models.StorageBackend.ToString() -> string!
+override abstract Weaviate.Client.Models.BackupBackend.<Clone>$() -> Weaviate.Client.Models.BackupBackend!
+override abstract Weaviate.Client.Models.ExportBackend.<Clone>$() -> Weaviate.Client.Models.ExportBackend!
+override sealed Weaviate.Client.Models.BackupBackend.Equals(Weaviate.Client.Models.StorageBackend? other) -> bool
+override sealed Weaviate.Client.Models.ExportBackend.Equals(Weaviate.Client.Models.StorageBackend? other) -> bool
+static Weaviate.Client.Models.ExportBackend.Azure(string? bucket = null, string? path = null) -> Weaviate.Client.Models.StorageBackend!
+static Weaviate.Client.Models.ExportBackend.Filesystem(string? path = null) -> Weaviate.Client.Models.StorageBackend!
+static Weaviate.Client.Models.ExportBackend.GCS(string? bucket = null, string? path = null) -> Weaviate.Client.Models.StorageBackend!
+static Weaviate.Client.Models.ExportBackend.S3(string? bucket = null, string? path = null) -> Weaviate.Client.Models.StorageBackend!
+static Weaviate.Client.Models.ExportBackend.operator !=(Weaviate.Client.Models.ExportBackend? left, Weaviate.Client.Models.ExportBackend? right) -> bool
+static Weaviate.Client.Models.ExportBackend.operator ==(Weaviate.Client.Models.ExportBackend? left, Weaviate.Client.Models.ExportBackend? right) -> bool
+static Weaviate.Client.Models.StorageBackend.operator !=(Weaviate.Client.Models.StorageBackend? left, Weaviate.Client.Models.StorageBackend? right) -> bool
+static Weaviate.Client.Models.StorageBackend.operator ==(Weaviate.Client.Models.StorageBackend? left, Weaviate.Client.Models.StorageBackend? right) -> bool
+virtual Weaviate.Client.Models.ExportBackend.Equals(Weaviate.Client.Models.ExportBackend? other) -> bool
+virtual Weaviate.Client.Models.StorageBackend.EqualityContract.get -> System.Type!
+virtual Weaviate.Client.Models.StorageBackend.Equals(Weaviate.Client.Models.StorageBackend? other) -> bool
+virtual Weaviate.Client.Models.StorageBackend.PrintMembers(System.Text.StringBuilder! builder) -> bool
