Skip to content

feat: Add ability to allowDiskUse #1623

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: alpha
Choose a base branch
from
Draft
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions src/ParseQuery.js
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ export type QueryJSON = {
hint?: mixed,
explain?: boolean,
readPreference?: string,
allowDiskUse?: Boolean,
includeReadPreference?: string,
subqueryReadPreference?: string,
};
Expand Down Expand Up @@ -239,6 +240,7 @@ class ParseQuery {
_count: boolean;
_order: Array<string>;
_readPreference: string;
_allowDiskUse: boolean;
_includeReadPreference: string;
_subqueryReadPreference: string;
_queriesLocalDatastore: boolean;
Expand Down Expand Up @@ -278,6 +280,7 @@ class ParseQuery {
this._limit = -1; // negative limit is not sent in the server request
this._skip = 0;
this._readPreference = null;
this._allowDiskUse = false;
this._includeReadPreference = null;
this._subqueryReadPreference = null;
this._queriesLocalDatastore = false;
Expand Down Expand Up @@ -457,6 +460,9 @@ class ParseQuery {
if (this._readPreference) {
params.readPreference = this._readPreference;
}
if (typeof this._allowDiskUse === 'boolean') {
params.allowDiskUse = this._allowDiskUse;
}
if (this._includeReadPreference) {
params.includeReadPreference = this._includeReadPreference;
}
Expand Down Expand Up @@ -534,6 +540,10 @@ class ParseQuery {
this._readPreference = json.readPreference;
}

if (typeof json.allowDiskUse === 'boolean') {
this._allowDiskUse = json.allowDiskUse;
}

if (json.includeReadPreference) {
this._includeReadPreference = json.includeReadPreference;
}
Expand Down Expand Up @@ -566,6 +576,7 @@ class ParseQuery {
'subqueryReadPreference',
'hint',
'explain',
'allowDiskUse',
].indexOf(key) === -1
) {
this._extraOptions[key] = json[key];
Expand Down Expand Up @@ -840,6 +851,7 @@ class ParseQuery {
hint: this._hint,
explain: this._explain,
readPreference: this._readPreference,
allowDiskUse: this._allowDiskUse,
};
return controller.aggregate(this.className, params, aggregateOptions).then(results => {
return results.results;
Expand Down Expand Up @@ -1955,6 +1967,17 @@ class ParseQuery {
return this;
}

/**
* Changes the allowDiskUse preference that the backend will use when performing the query to the database.
*
* @param {boolean} enabled enable/disable allowDiskUse
* @returns {Parse.Query} Returns the query, so you can chain this call.
*/
allowDiskUse(enabled: boolean): ParseQuery {
this._allowDiskUse = enabled;
return this;
}

/**
* Subscribe this query to get liveQuery updates
*
Expand Down