137 lines
3.6 KiB
JavaScript
137 lines
3.6 KiB
JavaScript
// @flow
|
|
export type SchemaType = any;
|
|
export type StorageClass = any;
|
|
export type QueryType = any;
|
|
|
|
export type QueryOptions = {
|
|
skip?: number,
|
|
limit?: number,
|
|
acl?: string[],
|
|
sort?: { [string]: number },
|
|
count?: boolean | number,
|
|
keys?: string[],
|
|
op?: string,
|
|
distinct?: boolean,
|
|
pipeline?: any,
|
|
readPreference?: ?string,
|
|
hint?: ?mixed,
|
|
explain?: Boolean,
|
|
caseInsensitive?: boolean,
|
|
action?: string,
|
|
addsField?: boolean,
|
|
comment?: string,
|
|
};
|
|
|
|
export type UpdateQueryOptions = {
|
|
many?: boolean,
|
|
upsert?: boolean,
|
|
};
|
|
|
|
export type FullQueryOptions = QueryOptions & UpdateQueryOptions;
|
|
|
|
export interface StorageAdapter {
|
|
canSortOnJoinTables: boolean;
|
|
schemaCacheTtl: ?number;
|
|
enableSchemaHooks: boolean;
|
|
|
|
classExists(className: string): Promise<boolean>;
|
|
setClassLevelPermissions(className: string, clps: any): Promise<void>;
|
|
createClass(className: string, schema: SchemaType): Promise<void>;
|
|
addFieldIfNotExists(className: string, fieldName: string, type: any): Promise<void>;
|
|
updateFieldOptions(className: string, fieldName: string, type: any): Promise<void>;
|
|
deleteClass(className: string): Promise<void>;
|
|
deleteAllClasses(fast: boolean): Promise<void>;
|
|
deleteFields(className: string, schema: SchemaType, fieldNames: Array<string>): Promise<void>;
|
|
getAllClasses(): Promise<StorageClass[]>;
|
|
getClass(className: string): Promise<StorageClass>;
|
|
createObject(
|
|
className: string,
|
|
schema: SchemaType,
|
|
object: any,
|
|
transactionalSession: ?any
|
|
): Promise<any>;
|
|
deleteObjectsByQuery(
|
|
className: string,
|
|
schema: SchemaType,
|
|
query: QueryType,
|
|
transactionalSession: ?any
|
|
): Promise<void>;
|
|
updateObjectsByQuery(
|
|
className: string,
|
|
schema: SchemaType,
|
|
query: QueryType,
|
|
update: any,
|
|
transactionalSession: ?any
|
|
): Promise<[any]>;
|
|
findOneAndUpdate(
|
|
className: string,
|
|
schema: SchemaType,
|
|
query: QueryType,
|
|
update: any,
|
|
transactionalSession: ?any
|
|
): Promise<any>;
|
|
upsertOneObject(
|
|
className: string,
|
|
schema: SchemaType,
|
|
query: QueryType,
|
|
update: any,
|
|
transactionalSession: ?any
|
|
): Promise<any>;
|
|
find(
|
|
className: string,
|
|
schema: SchemaType,
|
|
query: QueryType,
|
|
options: QueryOptions
|
|
): Promise<[any]>;
|
|
ensureIndex(
|
|
className: string,
|
|
schema: SchemaType,
|
|
fieldNames: string[],
|
|
indexName?: string,
|
|
caseSensitive?: boolean,
|
|
options?: Object
|
|
): Promise<any>;
|
|
ensureUniqueness(className: string, schema: SchemaType, fieldNames: Array<string>): Promise<void>;
|
|
count(
|
|
className: string,
|
|
schema: SchemaType,
|
|
query: QueryType,
|
|
readPreference?: string,
|
|
estimate?: boolean,
|
|
hint?: mixed,
|
|
comment?: string
|
|
): Promise<number>;
|
|
distinct(
|
|
className: string,
|
|
schema: SchemaType,
|
|
query: QueryType,
|
|
fieldName: string
|
|
): Promise<any>;
|
|
aggregate(
|
|
className: string,
|
|
schema: any,
|
|
pipeline: any,
|
|
readPreference: ?string,
|
|
hint: ?mixed,
|
|
explain?: boolean,
|
|
comment?: string
|
|
): Promise<any>;
|
|
performInitialization(options: ?any): Promise<void>;
|
|
watch(callback: () => void): void;
|
|
|
|
// Indexing
|
|
createIndexes(className: string, indexes: any, conn: ?any): Promise<void>;
|
|
getIndexes(className: string, connection: ?any): Promise<void>;
|
|
updateSchemaWithIndexes(): Promise<void>;
|
|
setIndexesWithSchemaFormat(
|
|
className: string,
|
|
submittedIndexes: any,
|
|
existingIndexes: any,
|
|
fields: any,
|
|
conn: ?any
|
|
): Promise<void>;
|
|
createTransactionalSession(): Promise<any>;
|
|
commitTransactionalSession(transactionalSession: any): Promise<void>;
|
|
abortTransactionalSession(transactionalSession: any): Promise<void>;
|
|
}
|