FractalDataWorks.Data.DataStores.Abstractions 0.4.0-preview.6

FractalDataWorks.Data.DataStores.Abstractions

Abstractions for data store operations providing unified access patterns for databases, file systems, REST APIs, and other data sources.

Overview

Defines contracts for data store operations representing WHERE data is physically stored, separate from HOW it is accessed (connections) or WHAT format it is in (containers):

• IDataStore: Core abstraction for data storage locations
• IDataStoreType: Metadata about storage backend capabilities via TypeCollection pattern
• DataStoreBase: Base implementation with common functionality

Target Framework: .NET Standard 2.0

Dependencies:

• FractalDataWorks.Data.Abstractions
• FractalDataWorks.Collections
• FractalDataWorks.Results

Key Interfaces

IDataStore

From IDataStore.cs:21-120:

public interface IDataStore
{
    string Id { get; }
    string Name { get; }
    string StoreType { get; }
    string TranslatorType { get; }
    string Location { get; }
    IReadOnlyDictionary<string, object> Metadata { get; }
    IEnumerable<IDataPath> AvailablePaths { get; }

    Task<IGenericResult> TestConnection();
    Task<IGenericResult<IEnumerable<IDataPath>>> DiscoverPaths();
    IDataPath? GetPath(string pathName);
    IGenericResult ValidateConnectionCompatibility(string connectionType);
}

IDataStore<TConfiguration>

From IDataStore.cs:131-151:

public interface IDataStore<TConfiguration> : IDataStore
    where TConfiguration : class
{
    TConfiguration Configuration { get; }
    Task<IGenericResult> UpdateConfiguration(TConfiguration configuration);
}

IDataStoreType

From IDataStoreType.cs:12-30:

public interface IDataStoreType : ITypeOption<int>
{
    bool SupportsRead { get; }
    bool SupportsWrite { get; }
    bool SupportsTransactions { get; }
}

DataStoreTypes (TypeCollection)

From DataStoreTypes.cs:15-19:

[TypeCollection(typeof(DataStoreTypeBase), typeof(IDataStoreType), typeof(DataStoreTypes))]
public abstract partial class DataStoreTypes : TypeCollectionBase<DataStoreTypeBase, IDataStoreType>
{
}

Usage

From test file SqlServerDataStoreTests.cs:13-34:

// Create a data store with configuration
var config = new SqlServerConfiguration
{
    ConnectionString = "Server=localhost;Database=test;"
};

var dataStore = new SqlServerDataStore("test-id", "test-name", config);

// Test connectivity
var result = await dataStore.TestConnection();
if (result.IsSuccess)
{
    // Discover available paths (tables, views)
    var pathsResult = await dataStore.DiscoverPaths();
}

// Validate connection type compatibility
var compatResult = dataStore.ValidateConnectionCompatibility("MsSql");

Best Practices

• Use TestConnection() to validate configuration before operations
• Call ValidateConnectionCompatibility() to verify store-connection compatibility
• Implement DataStoreBase<TConfiguration> for common functionality
• Return IGenericResult for all operations that can fail
• Use TypeCollection pattern for extensible store types

Related Packages

• FractalDataWorks.Data.Abstractions - Core data abstractions including IDataPath
• FractalDataWorks.Data.DataStores.SqlServer - SQL Server implementation
• FractalDataWorks.Results - Result types for Railway-Oriented Programming