DBObjectGCSAdapter class

A DBObjectAdapter that stores objects in Google Cloud Storage (GCS).

• See https://cloud.google.com/storage

Inheritance

• Object
• SchemeProvider
• DBAdapter<DBObjectGCSAdapterContext>
• DBObjectGCSAdapter

Available extensions

• EntityRepositoryProviderExtension

Constructors

DBObjectGCSAdapter(Client client, String projectName, String bucketName, {Directory? cacheDirectory, int? cacheLimit, bool generateTables = false, Object? populateTables, Object? populateSource, Object? populateSourceVariables, EntityRepositoryProvider? parentRepositoryProvider, String? workingPath, bool log = false})

Properties

bucket ↔ Bucket

late, final

bucketName → String

final

cacheDirectory → Directory?

final

cacheLimit → int?

final

callCloseTransactionRequired → bool

no setter, override

cancelTransactionResultWithError → bool

no setter, override

capability → DBAdapterCapability

The DBAdapter capability.

final, inherited

connectionInactivityLimit ↔ Duration

The maximum allowed duration of inactivity for a connection in the pool. Default: 15min

getter/setter pair, inherited

dialect → DBDialect

The DB dialect of this adapter.

no setter, inherited

dialectName → String

The DB dialect name of this adapter.

no setter, inherited

entityRepositories → List<EntityRepository<Object>>

no setter, inherited

entityRepositoriesBuildOrder → List<EntityRepository<Object>>

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

initializationStatus → InitializationStatus

Returns the current InitializationStatus.

no setter, inherited

instanceID → int

final, inherited

isAsyncInitialization → bool

Returns true if this instance initialization was asynchronous.

no setter, inherited

isClosed → bool

no setter, inherited

isInitialized → bool

Returns true if this instance is already initialized.

no setter, inherited

isInitializing → bool

Returns true if this instance is in the middle of the initialization process.

no setter, inherited

isPoolEmpty → bool

no setter, inherited

isPoolNotEmpty → bool

no setter, inherited

lastCheckPoolElapsedTimeMs → int

no setter, inherited

log → bool

final, inherited

maxConnections → int

The maximum number of connections in the pool of this adapter.

final, inherited

minConnections → int

The minimum number of connections in the pool of this adapter.

final, inherited

name → String

The name of the adapter.

final, inherited

onClose → Stream<DBAdapter<DBObjectGCSAdapterContext>>

On close events.

late, final, inherited

parentRepositoryProvider → EntityRepositoryProvider?

final, inherited

poolAliveElementsSize → int

no setter, inherited

poolCreatedElementsCount → int

no setter, inherited

poolDisposedElementsCount → int

no setter, inherited

poolElements → Iterable<DBObjectGCSAdapterContext>

no setter, inherited

poolFullWaitTimeout → Duration

no setter, inherited

poolFullYieldTimeout → Duration

no setter, inherited

poolSize → int

no setter, inherited

poolSizeDesiredLimit → int

no setter, inherited

poolYieldTimeout → Duration

no setter, inherited

projectName → String

final

registeredEntityRepositories → List<EntityRepository<Object>>

no setter, inherited

registeredEntityRepositoriesInformation → Map<EntityRepository<Object>, Object>

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

storage ↔ Storage

late, final

tablesSchemes → Map<String, TableScheme>

final

throwTransactionResultWithError → bool

no setter, override

Methods

addTableSchemes(Iterable<TableScheme> tablesSchemes) → void

allRepositories({Map<Type, EntityRepository<Object>>? allRepositories, Set<EntityRepositoryProvider>? traversedProviders}) → Map<Type, EntityRepository<Object>>

inherited

callCheckPool() → FutureOr<bool>

inherited

cancelTransaction(Transaction transaction, DBObjectGCSAdapterContext? connection, Object? error, StackTrace? stackTrace) → bool

override

catchFromPool({Duration? timeout}) → FutureOr<DBObjectGCSAdapterContext>

inherited

catchFromPopulatedPool() → FutureOr<DBObjectGCSAdapterContext?>

inherited

checkConnections() → FutureOr<bool>

Checks the connections of the pool. Defaults: calls removeInvalidElementsFromPool.

inherited

checkDB() → FutureOr<bool>

inherited

checkEntityFields<O>(O o, String entityName, String table, {EntityHandler<O>? entityHandler}) → void

inherited

checkInitialized() → void

Checks if this instance is initialized.

inherited

checkNotClosed() → void

inherited

checkPool() → FutureOr<bool>

Checks the pool connections and limits.

inherited

checkPoolSize(int minSize, int maxSize, int checkInvalidsIntervalMs) → FutureOr<bool>

inherited

clearPool() → FutureOr<bool>

inherited

close() → bool

inherited

closeConnection(DBObjectGCSAdapterContext connection) → bool

override

closePoolElement(DBObjectGCSAdapterContext o) → FutureOr<bool>

Defaults: calls closeConnection.

inherited

closeTransaction(Transaction transaction, DBObjectGCSAdapterContext? connection) → FutureOr<void>

override

createConnection() → DBObjectGCSAdapterContext

Creates a connection C for this adapte

override

createPoolElement({bool force = false}) → FutureOr<DBObjectGCSAdapterContext?>

Defaults: calls createConnection.

inherited

createPoolElementForced() → FutureOr<DBObjectGCSAdapterContext>

inherited

createRepositoryAdapter<O>(String name, {String? tableName, Type? type}) → DBRepositoryAdapter<O>?

inherited

disposePoolElement(DBObjectGCSAdapterContext o) → FutureOr<bool>

inherited

disposeTableSchemeCache(String table) → TableScheme?

Disposes a TableScheme for table. Forces refresh of previous scheme.

inherited

doCount(TransactionOperation op, String entityName, String table, {EntityMatcher? matcher, Object? parameters, List? positionalParameters, Map<String, Object?>? namedParameters, PreFinishDBOperation<int, int>? preFinish}) → FutureOr<int>

override

doDelete<R>(TransactionOperation op, String entityName, String table, EntityMatcher matcher, {Object? parameters, List? positionalParameters, Map<String, Object?>? namedParameters, PreFinishDBOperation<Iterable<Map<String, dynamic>>, R>? preFinish}) → FutureOr<R>

override

doExistIDs<I extends Object>(TransactionOperation op, String entityName, String table, List<I> ids) → FutureOr<List<I>>

override

doInitialization({Initializable? parent}) → FutureOr<InitializationResult>

Initialize this instance if is not initialized yet.

inherited

doInsert<O>(TransactionOperation op, String entityName, String table, O o, Map<String, dynamic> fields, {String? idFieldName, PreFinishDBOperation? preFinish}) → FutureOr

override

doSelectAll<R>(TransactionOperation op, String entityName, String table, {PreFinishDBOperation<Iterable<Map<String, dynamic>>, List<R>>? preFinish}) → FutureOr<List<R>>

override

doSelectByID<R>(TransactionOperation op, String entityName, String table, Object id, {PreFinishDBOperation<Map<String, dynamic>?, R?>? preFinish}) → FutureOr<R?>

override

doSelectByIDs<R>(TransactionOperation op, String entityName, String table, List<Object> ids, {PreFinishDBOperation<List<Map<String, dynamic>>, List<R>>? preFinish}) → FutureOr<List<R>>

override

doUpdate<O>(TransactionOperation op, String entityName, String table, O o, Object id, Map<String, dynamic> fields, {String? idFieldName, PreFinishDBOperation? preFinish, bool allowAutoInsert = false}) → FutureOr

override

ensureInitialized({Initializable? parent}) → FutureOr<InitializationResult>

Ensures that this instance is initialized.

inherited

ensureInitializedAsync({Initializable? parent}) → FutureOr<InitializationResult>

Ensures that this instance is initialized. If is not initialized yet it will force an asynchronous initialization and return a Future.

inherited

executeInitialized<R>(ExecuteInitializedCallback<R> callback, {Initializable? parent}) → FutureOr<R>

Executes the callback ensuring that this instances was fully initialized.

inherited

executeTransactionOperation<R>(TransactionOperation op, FutureOr<R> f(DBObjectGCSAdapterContext connection)) → FutureOr<R>

executeWithPool<R>(FutureOr<R> f(DBObjectGCSAdapterContext o), {Duration? timeout, bool validator(DBObjectGCSAdapterContext o)?, dynamic onError(Object error, StackTrace stackTrace)?}) → FutureOr<R>

inherited

filterPoolElements(FutureOr<bool> filter(DBObjectGCSAdapterContext o)) → FutureOr<List<DBObjectGCSAdapterContext>>

inherited

getConnectionURL(DBObjectGCSAdapterContext connection) → String

Returns the URL of the connection.

override

getEntityByID<O>(dynamic id, {Type? type, bool sync = false, EntityResolutionRules? resolutionRules}) → FutureOr<O?>

inherited

getEntityHandler<T>({String? entityName, String? tableName, Type? entityType}) → EntityHandler<T>?

inherited

getEntityID(Object entity, {String? entityName, String? tableName, Type? entityType, EntityHandler? entityHandler}) → Object?

Returns the entity ID for entityName, tableName or entityType.

inherited

getEntityRepositoresTables() → FutureOr<Map<EntityRepository<Object>, String>>

inherited

getEntityRepository<O extends Object>({O? obj, Type? type, String? name, String? tableName}) → EntityRepository<O>?

inherited

getEntityRepositoryByType<O extends Object>(Type type) → EntityRepository<O>?

inherited

getEntityRepositoryByTypeInfo<O extends Object>(TypeInfo typeInfo) → EntityRepository<O>?

inherited

getFieldType(String field, {String? entityName, String? tableName, Type? entityType}) → FutureOr<TypeInfo?>

Returns the type for the field at tableName or by entityName.

inherited

getRepositoryAdapterByName<O>(String name) → DBRepositoryAdapter<O>?

inherited

getRepositoryAdapterByTableName<O>(String tableName) → DBRepositoryAdapter<O>?

inherited

getRepositoryAdapterByType<O>(Type type) → DBRepositoryAdapter<O>?

inherited

getTableFieldsTypes(String table) → FutureOr<Map<String, Type>?>

Returns a TableScheme.fieldsTypes for table.

inherited

getTableFieldsTypesImpl(String table) → FutureOr<Map<String, Type>?>

override

getTableForEntityRepository(EntityRepository<Object> entityRepository) → String

Returns the table name for entityRepository.

inherited

getTableForType(TypeInfo type) → String?

Returns the table name for type.

inherited

getTableScheme(String table, {TableRelationshipReference? relationship, Object? contextID}) → FutureOr<TableScheme?>

Returns a TableScheme for table. Calls getTableSchemeImpl handling asynchronous calls.

inherited

getTableSchemeForEntityRepository(EntityRepository<Object> entityRepository, {Object? contextID}) → FutureOr<TableScheme?>

Returns a TableScheme for entityRepository.

inherited

getTableSchemeForType(TypeInfo type) → FutureOr<TableScheme?>

Returns a TableScheme for type.

inherited

getTableSchemeIfLoaded(String table) → TableScheme?

inherited

getTableSchemeImpl(String table, TableRelationshipReference? relationship, {Object? contextID}) → TableScheme?

Implementation that returns a TableScheme for table.

override

information({bool extended = false, String? table}) → Map<String, dynamic>

override

initialize() → FutureOr<InitializationResult>

Initialization implementation. Do not call it directly, use doInitialization.

inherited

initializeDependencies() → List<Initializable>

Return a List of Initializable instances that need to be initialized BEFORE initialize this instance.

inherited

instantiateRepositoryAdapter<O>(String name, String? tableName, Type? type) → DBRepositoryAdapter<O>

inherited

invalidPoolElements({bool checkUsage = true}) → FutureOr<List<DBObjectGCSAdapterContext>>

inherited

isConnectionValid(DBObjectGCSAdapterContext connection, {bool checkUsage = true}) → FutureOr<bool>

Returns true if connection is valid for usage.

override

isPoolElementInvalid(DBObjectGCSAdapterContext o, {bool checkUsage = true}) → FutureOr<bool>

inherited

isPoolElementValid(DBObjectGCSAdapterContext o, {bool checkUsage = true}) → FutureOr<bool>

Defaults: calls isConnectionValid.

inherited

isTransactionWithSingleOperation(TransactionOperation op) → bool

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

notifyKnownEntityRepositoryProvider(EntityRepositoryProvider provider) → void

inherited

notifyTableFieldTypes(String table, Map<String, Type> fieldsTypes) → Map<String, Type>

inherited

openTransaction(Transaction transaction) → DBObjectGCSAdapterContext

override

peekFromPool() → FutureOr<DBObjectGCSAdapterContext?>

inherited

populateImpl() → FutureOr<InitializationResult>

inherited

preparePoolElement(DBObjectGCSAdapterContext o) → FutureOr<DBObjectGCSAdapterContext?>

inherited

recyclePoolElement(DBObjectGCSAdapterContext o) → FutureOr<DBObjectGCSAdapterContext?>

inherited

registerEntityRepository<O extends Object>(EntityRepository<O> entityRepository) → void

inherited

releaseIntoPool(DBObjectGCSAdapterContext o) → FutureOr<bool>

inherited

removeElementsFromPool(int amount) → int

inherited

removeFromPool(DBObjectGCSAdapterContext o) → bool

inherited

removeInvalidElementsFromPool({bool checkUsage = true}) → FutureOr<bool>

inherited

resolveError(Object error, StackTrace stackTrace, Object? operation, Object? previousError) → Object

resolveTransactionResult(dynamic result, Transaction transaction, DBObjectGCSAdapterContext? connection) → FutureOr

inherited

selectIDFieldName(String table, List<String> primaryKeyCandidates) → String

Selects the ID field name from primaryKeyCandidates candidates:

inherited

toString() → String

A string representation of this object.

override

validPoolElements() → FutureOr<List<DBObjectGCSAdapterContext>>

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

boot() → void

createGCSClient(dynamic credential) → Future<AutoRefreshingAuthClient>

fromConfig(Map<String, dynamic>? config, {EntityRepositoryProvider? parentRepositoryProvider, String? workingPath}) → Future<DBObjectGCSAdapter>