DatabaseResource class

Database schemas, taxonomies, aggregates, integrations, schema triggers.

Inheritance

• Object
• Resource
• DatabaseResource

Constructors

DatabaseResource(Transport transport)

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

transport → Transport

final, inherited

Methods

aggregateRecords({required Object collectionName, Map<String, Object?>? query, Object? body, Map<String, String>? headers}) → Future<Object?>

POST /{version}/database/collections/{collectionName}/aggregate

analyzeImportFile({Map<String, Object?>? query, Object? body, Map<String, String>? headers}) → Future<Object?>

POST /{version}/database/imports/analyze

applyDatabaseSchemaBundle({Map<String, Object?>? query, Object? body, Map<String, String>? headers}) → Future<Object?>

POST /{version}/database/schemas/apply-bundle

changeRecordResponsibility({required Object collectionName, required Object id, Map<String, Object?>? query, Object? body, Map<String, String>? headers}) → Future<Object?>

PUT /{version}/database/collections/{collectionName}/{id}/responsibility

countRecords({required Object collectionName, Map<String, Object?>? query, Map<String, String>? headers}) → Future<Object?>

GET /{version}/database/collections/{collectionName}/count

createCollectionImport({Map<String, Object?>? query, Object? body, Map<String, String>? headers}) → Future<Object?>

POST /{version}/database/imports

deleteCollectionImport({required Object id, Map<String, Object?>? query, Object? body, Map<String, String>? headers}) → Future<Object?>

DELETE /{version}/database/imports/{id}

deleteDatabaseAggregate({required Object id, Map<String, Object?>? query, Object? body, Map<String, String>? headers}) → Future<Object?>

DELETE /{version}/database/aggregates/{id}

deleteDatabaseIntegration({required Object id, Map<String, Object?>? query, Object? body, Map<String, String>? headers}) → Future<Object?>

DELETE /{version}/database/integrations/{id}

deleteDatabaseSchema({required Object id, Map<String, Object?>? query, Object? body, Map<String, String>? headers}) → Future<Object?>

DELETE /{version}/database/schemas/{id}

deleteDatabaseTaxonomy({required Object id, Map<String, Object?>? query, Object? body, Map<String, String>? headers}) → Future<Object?>

DELETE /{version}/database/taxonomies/{id}

deleteDatabaseTaxonomyTerm({required Object taxonomyId, required Object id, Map<String, Object?>? query, Object? body, Map<String, String>? headers}) → Future<Object?>

DELETE /{version}/database/taxonomies/{taxonomyId}/terms/{id}

deleteManyDatabaseTaxonomyTerms({required Object taxonomyId, Map<String, Object?>? query, Object? body, Map<String, String>? headers}) → Future<Object?>

DELETE /{version}/database/taxonomies/{taxonomyId}/terms/many

deleteManyRecords({required Object collectionName, Map<String, Object?>? query, Object? body, Map<String, String>? headers}) → Future<Object?>

DELETE /{version}/database/collections/{collectionName}/many

deleteRecord({required Object collectionName, required Object id, Map<String, Object?>? query, Object? body, Map<String, String>? headers}) → Future<Object?>

DELETE /{version}/database/collections/{collectionName}/{id}

deleteSchemaTrigger({required Object triggerId, Map<String, Object?>? query, Object? body, Map<String, String>? headers}) → Future<Object?>

DELETE /{version}/database/schemas/triggers/{triggerId}

disableDatabase({Map<String, Object?>? query, Object? body, Map<String, String>? headers}) → Future<Object?>

PUT /{version}/database/disable

disableDatabaseIntegration({required Object id, Map<String, Object?>? query, Object? body, Map<String, String>? headers}) → Future<Object?>

PUT /{version}/database/integrations/{id}/disable

disableSchemaTrigger({required Object triggerId, Map<String, Object?>? query, Object? body, Map<String, String>? headers}) → Future<Object?>

PATCH /{version}/database/schemas/triggers/{triggerId}/disable

discardDatabaseSchemaDraft({required Object id, Map<String, Object?>? query, Object? body, Map<String, String>? headers}) → Future<Object?>

DELETE /{version}/database/schemas/{id}/draft

distinctRecordValues({required Object collectionName, Map<String, Object?>? query, Map<String, String>? headers}) → Future<Object?>

GET /{version}/database/collections/{collectionName}/distinct

enableDatabase({Map<String, Object?>? query, Object? body, Map<String, String>? headers}) → Future<Object?>

PUT /{version}/database/enable

enableDatabaseIntegration({required Object id, Map<String, Object?>? query, Object? body, Map<String, String>? headers}) → Future<Object?>

PUT /{version}/database/integrations/{id}/enable

enableSchemaTrigger({required Object triggerId, Map<String, Object?>? query, Object? body, Map<String, String>? headers}) → Future<Object?>

PATCH /{version}/database/schemas/triggers/{triggerId}/enable

executeRecordsAggregate({required Object collectionName, required Object aggregateId, Map<String, Object?>? query, Object? body, Map<String, String>? headers}) → Future<Object?>

POST /{version}/database/collections/{collectionName}/aggregates/{aggregateId}/execute

findOneRecord({required Object collectionName, required Object id, Map<String, Object?>? query, bool? expandReferences, Map<String, String>? headers}) → Future<Object?>

GET /{version}/database/collections/{collectionName}/{id}

findRecords({required Object collectionName, Map<String, Object?>? query, bool? expandReferences, Map<String, String>? headers}) → Future<Object?>

GET /{version}/database/collections/{collectionName}

getAllowedFlexTiers({Map<String, Object?>? query, Map<String, String>? headers}) → Future<Object?>

GET /{version}/database/integrations/flex-tiers

getCollectionImport({required Object id, Map<String, Object?>? query, Map<String, String>? headers}) → Future<Object?>

GET /{version}/database/imports/{id}

getCollectionImports({Map<String, Object?>? query, Map<String, String>? headers}) → Future<Object?>

GET /{version}/database/imports

getCollectionIndexes({required Object collectionName, Map<String, Object?>? query, Map<String, String>? headers}) → Future<Object?>

GET /{version}/database/collections/{collectionName}/indexes

getDatabaseAggregate({required Object id, Map<String, Object?>? query, Map<String, String>? headers}) → Future<Object?>

GET /{version}/database/aggregates/{id}

getDatabaseAggregates({Map<String, Object?>? query, Map<String, String>? headers}) → Future<Object?>

GET /{version}/database/aggregates

getDatabaseIntegration({required Object id, Map<String, Object?>? query, Map<String, String>? headers}) → Future<Object?>

GET /{version}/database/integrations/{id}

getDatabaseIntegrations({Map<String, Object?>? query, Map<String, String>? headers}) → Future<Object?>

GET /{version}/database/integrations

getDatabaseMergedTermTree({required Object taxonomyName, Map<String, Object?>? query, Map<String, String>? headers}) → Future<Object?>

GET /{version}/database/taxonomies/{taxonomyName}/merged-tree

getDatabaseSchema({required Object id, Map<String, Object?>? query, Map<String, String>? headers}) → Future<Object?>

GET /{version}/database/schemas/{id}

getDatabaseSchemaDraft({required Object id, Map<String, Object?>? query, Map<String, String>? headers}) → Future<Object?>

GET /{version}/database/schemas/{id}/draft

getDatabaseSchemaIndexStatus({required Object id, Map<String, Object?>? query, Map<String, String>? headers}) → Future<Object?>

GET /{version}/database/schemas/{id}/list-settings GET /{version}/database/schemas/{id}/index-status — the last schema-index run of the collection (state building | ready | refused | partial, one entry per database).

getDatabaseSchemaListSettings({required Object id, Map<String, Object?>? query, Map<String, String>? headers}) → Future<Object?>

getDatabaseSchemas({Map<String, Object?>? query, Map<String, String>? headers}) → Future<Object?>

GET /{version}/database/schemas

getDatabaseSchemaVersionDiff({required Object id, Map<String, Object?>? query, Map<String, String>? headers}) → Future<Object?>

GET /{version}/database/schemas/{id}/versions/diff

getDatabaseSchemaVersions({required Object id, Map<String, Object?>? query, Map<String, String>? headers}) → Future<Object?>

GET /{version}/database/schemas/{id}/versions

getDatabaseTaxonomies({Map<String, Object?>? query, Map<String, String>? headers}) → Future<Object?>

GET /{version}/database/taxonomies

getDatabaseTaxonomy({required Object id, Map<String, Object?>? query, Map<String, String>? headers}) → Future<Object?>

GET /{version}/database/taxonomies/{id}

getDatabaseTaxonomyTerm({required Object taxonomyId, required Object id, Map<String, Object?>? query, Map<String, String>? headers}) → Future<Object?>

GET /{version}/database/taxonomies/{taxonomyId}/terms/{id}

getDatabaseTaxonomyTermTree({required Object taxonomyName, Map<String, Object?>? query, Map<String, String>? headers}) → Future<Object?>

GET /{version}/database/taxonomies/{taxonomyName}/terms/tree

getDatabaseTaxonomyTree({Map<String, Object?>? query, Map<String, String>? headers}) → Future<Object?>

GET /{version}/database/taxonomies/tree

getSchemaTrigger({required Object id, Map<String, Object?>? query, Map<String, String>? headers}) → Future<Object?>

GET /{version}/database/schemas/triggers/{id}

getSchemaTriggers({Map<String, Object?>? query, Map<String, String>? headers}) → Future<Object?>

GET /{version}/database/schemas/triggers

insertManyRecords({required Object collectionName, Map<String, Object?>? query, Object? body, Map<String, String>? headers}) → Future<Object?>

POST /{version}/database/collections/{collectionName}/many

insertRecord({required Object collectionName, Map<String, Object?>? query, Object? body, Map<String, String>? headers}) → Future<Object?>

POST /{version}/database/collections/{collectionName}

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

publishDatabaseSchema({required Object id, Map<String, Object?>? query, Object? body, Map<String, String>? headers}) → Future<Object?>

POST /{version}/database/schemas/{id}/publish

renameDatabaseSchema({required Object id, Map<String, Object?>? query, Object? body, Map<String, String>? headers}) → Future<Object?>

PUT /{version}/database/schemas/{id}/rename

replaceRecord({required Object collectionName, required Object id, Map<String, Object?>? query, Object? body, Map<String, String>? headers}) → Future<Object?>

PUT /{version}/database/collections/{collectionName}/{id}/replace

requestImportUploadUrl({Map<String, Object?>? query, Object? body, Map<String, String>? headers}) → Future<Object?>

POST /{version}/database/imports/upload-url

revealManagedFlexConnectionString({required Object id, Map<String, Object?>? query, Map<String, String>? headers}) → Future<Object?>

GET /{version}/database/integrations/{id}/connection-string

saveDatabaseAggregate({Map<String, Object?>? query, Object? body, Map<String, String>? headers}) → Future<Object?>

POST /{version}/database/aggregates

saveDatabaseIntegration({Map<String, Object?>? query, Object? body, Map<String, String>? headers}) → Future<Object?>

POST /{version}/database/integrations

saveDatabaseSchema({Map<String, Object?>? query, Object? body, Map<String, String>? headers}) → Future<Object?>

POST /{version}/database/schemas

saveDatabaseTaxonomy({Map<String, Object?>? query, Object? body, Map<String, String>? headers}) → Future<Object?>

POST /{version}/database/taxonomies

saveDatabaseTaxonomyTerm({required Object taxonomyId, Map<String, Object?>? query, Object? body, Map<String, String>? headers}) → Future<Object?>

POST /{version}/database/taxonomies/{taxonomyId}/terms

saveSchemaTrigger({Map<String, Object?>? query, Object? body, Map<String, String>? headers}) → Future<Object?>

POST /{version}/database/schemas/triggers

seedCollectionRecords({Map<String, Object?>? query, Object? body, Map<String, String>? headers}) → Future<Object?>

POST /{version}/database/collections/seed

setDatabaseIntegrationAsDefault({required Object id, Map<String, Object?>? query, Object? body, Map<String, String>? headers}) → Future<Object?>

PUT /{version}/database/integrations/{id}/default

testDatabaseAggregate({Map<String, Object?>? query, Object? body, Map<String, String>? headers}) → Future<Object?>

POST /{version}/database/aggregates/test

testDatabaseIntegration({Map<String, Object?>? query, Object? body, Map<String, String>? headers}) → Future<Object?>

POST /{version}/database/integrations/test

toString() → String

A string representation of this object.

inherited

updateDatabaseSchemaDraft({required Object id, Map<String, Object?>? query, Object? body, Map<String, String>? headers}) → Future<Object?>

PUT /{version}/database/schemas/{id}/draft

updateDatabaseSchemaEmbed({required Object id, Map<String, Object?>? query, Object? body, Map<String, String>? headers}) → Future<Object?>

PUT /{version}/database/schemas/{id}/embed

updateDatabaseSchemaListSettings({required Object id, Map<String, Object?>? query, Object? body, Map<String, String>? headers}) → Future<Object?>

PUT /{version}/database/schemas/{id}/list-settings

updateDatabaseSchemaSettings({required Object id, Map<String, Object?>? query, Object? body, Map<String, String>? headers}) → Future<Object?>

PUT /{version}/database/schemas/{id}/settings

updateDatabaseTaxonomyTerm({required Object taxonomyId, required Object id, Map<String, Object?>? query, Object? body, Map<String, String>? headers}) → Future<Object?>

PUT /{version}/database/taxonomies/{taxonomyId}/terms/{id}

updateManyRecords({required Object collectionName, Map<String, Object?>? query, Object? body, Object? arrayFilters, Map<String, String>? headers}) → Future<Object?>

PUT /{version}/database/collections/{collectionName}/many

updateOneRecord({required Object collectionName, required Object id, Map<String, Object?>? query, Object? body, Object? arrayFilters, Map<String, String>? headers}) → Future<Object?>

PUT /{version}/database/collections/{collectionName}/{id}

Operators

operator ==(Object other) → bool

The equality operator.

inherited