Skip to content

Commit

Permalink
adding code documentation for each method in indices
Browse files Browse the repository at this point in the history
  • Loading branch information
@brozeph
brozeph committed Jun 27, 2013
1 parent 18a596e commit 014e853
Showing 1 changed file with 30 additions and 1 deletion.
31 changes: 30 additions & 1 deletion lib/indices.js
View file
Expand Up @@ -9,6 +9,7 @@ module.exports = function (config, req, self) {
var paramExcludes = Object.keys(config)
.concat(['_index', '_indices', '_type', '_types', 'alias']);

// http://www.elasticsearch.org/guide/reference/api/admin-indices-aliases/
self.alias = function (options, data, callback) {
if (!callback && typeof data === 'function') {
callback = data;
Expand All @@ -32,7 +33,8 @@ module.exports = function (config, req, self) {
}
};

// does not currently support pre 0.90 ways of retrieving aliases
// http://www.elasticsearch.org/guide/reference/api/admin-indices-aliases/
// Disclaimer: does not currently support pre 0.90 ways of retrieving aliases
self.aliases = function (options, callback) {
if (!callback && typeof options === 'function') {
callback = options;
Expand All @@ -54,6 +56,7 @@ module.exports = function (config, req, self) {
return req.get(options, callback);
};

// http://www.elasticsearch.org/guide/reference/api/admin-indices-analyze/
self.analyze = function (options, data, callback) {
if (!callback && typeof data === 'function') {
callback = data;
Expand All @@ -74,6 +77,7 @@ module.exports = function (config, req, self) {
return req.get(options, data, callback);
};

// http://www.elasticsearch.org/guide/reference/api/admin-indices-clearcache/
self.clearCache = function (options, callback) {
if (!callback && typeof options === 'function') {
callback = options;
Expand All @@ -91,6 +95,7 @@ module.exports = function (config, req, self) {
return req.post(options, callback);
};

// http://www.elasticsearch.org/guide/reference/api/admin-indices-open-close/
self.closeIndex = function (options, callback) {
if (!callback && typeof options === 'function') {
callback = options;
Expand All @@ -112,6 +117,7 @@ module.exports = function (config, req, self) {
return req.post(options, callback);
};

// http://www.elasticsearch.org/guide/reference/api/admin-indices-create-index/
self.createIndex = function (options, data, callback) {
if (!callback && typeof data === 'function') {
callback = data;
Expand Down Expand Up @@ -142,6 +148,7 @@ module.exports = function (config, req, self) {
}
};

// http://www.elasticsearch.org/guide/reference/api/admin-indices-templates/
self.createTemplate = function (options, template, callback) {
if (!callback && typeof template === 'function') {
callback = template;
Expand All @@ -162,6 +169,7 @@ module.exports = function (config, req, self) {
return req.put(options, template, callback);
};

// http://www.elasticsearch.org/guide/reference/api/admin-indices-aliases/
self.deleteAlias = function (options, callback) {
if (!callback && typeof options === 'function') {
callback = options;
Expand All @@ -184,6 +192,7 @@ module.exports = function (config, req, self) {
return req.delete(options, callback);
};

// http://www.elasticsearch.org/guide/reference/api/admin-indices-delete-index/
self.deleteIndex = function (options, callback) {
if (!callback && typeof options === 'function') {
callback = options;
Expand All @@ -204,6 +213,7 @@ module.exports = function (config, req, self) {
return req.delete(options, callback);
};

// http://www.elasticsearch.org/guide/reference/api/admin-indices-delete-mapping/
self.deleteMapping = function (options, callback) {
if (!callback && typeof options === 'function') {
callback = options;
Expand All @@ -226,6 +236,7 @@ module.exports = function (config, req, self) {
return req.delete(options, callback);
};

// http://www.elasticsearch.org/guide/reference/api/admin-indices-templates/
self.deleteTemplate = function (options, callback) {
if (!callback && typeof options === 'function') {
callback = options;
Expand All @@ -245,6 +256,7 @@ module.exports = function (config, req, self) {
return req.delete(options, callback);
};

// http://www.elasticsearch.org/guide/reference/api/admin-indices-warmers/
self.deleteWarmer = function (options, callback) {
if (!callback && typeof options === 'function') {
callback = options;
Expand All @@ -267,6 +279,9 @@ module.exports = function (config, req, self) {
return req.delete(options, callback);
};

// http://www.elasticsearch.org/guide/reference/api/admin-indices-indices-exists/
// http://www.elasticsearch.org/guide/reference/api/admin-indices-types-exists/
// Also replicated (somewhat) in core... core.exists is more flexible, however
self.exists = function (options, callback) {
if (!callback && typeof options === 'function') {
callback = options;
Expand Down Expand Up @@ -313,6 +328,7 @@ module.exports = function (config, req, self) {
return req.post(options, callback);
};

// http://www.elasticsearch.org/guide/reference/api/admin-indices-get-mapping/
self.mappings = function (options, callback) {
if (!callback && typeof options === 'function') {
callback = options;
Expand All @@ -331,6 +347,7 @@ module.exports = function (config, req, self) {
return req.get(options, callback);
};

// http://www.elasticsearch.org/guide/reference/api/admin-indices-open-close/
self.openIndex = function (options, callback) {
if (!callback && typeof options === 'function') {
callback = options;
Expand All @@ -352,6 +369,7 @@ module.exports = function (config, req, self) {
return req.post(options, callback);
};

// http://www.elasticsearch.org/guide/reference/api/admin-indices-optimize/
self.optimize = function (options, callback) {
if (!callback && typeof options === 'function') {
callback = options;
Expand All @@ -369,6 +387,7 @@ module.exports = function (config, req, self) {
return req.post(options, callback);
};

// http://www.elasticsearch.org/guide/reference/api/admin-indices-put-mapping/
self.putMapping = function (options, mapping, callback) {
if (!callback && typeof mapping === 'function') {
callback = mapping;
Expand All @@ -393,6 +412,7 @@ module.exports = function (config, req, self) {
return req.put(options, mapping, callback);
};

// http://www.elasticsearch.org/guide/reference/api/admin-indices-warmers/
self.putWarmer = function (options, warmer, callback) {
if (!callback && typeof warmer === 'function') {
callback = warmer;
Expand All @@ -418,6 +438,7 @@ module.exports = function (config, req, self) {
return req.put(options, warmer, callback);
};

// http://www.elasticsearch.org/guide/reference/api/admin-indices-refresh/
self.refresh = function (options, callback) {
if (!callback && typeof options === 'function') {
callback = options;
Expand All @@ -434,6 +455,7 @@ module.exports = function (config, req, self) {
return req.post(options, callback);
};

// http://www.elasticsearch.org/guide/reference/api/admin-indices-segments/
self.segments = function (options, callback) {
if (!callback && typeof options === 'function') {
callback = options;
Expand All @@ -450,6 +472,7 @@ module.exports = function (config, req, self) {
return req.get(options, callback);
};

// http://www.elasticsearch.org/guide/reference/api/admin-indices-get-settings/
self.settings = function (options, callback) {
if (!callback && typeof options === 'function') {
callback = options;
Expand All @@ -471,6 +494,7 @@ module.exports = function (config, req, self) {
return req.get(options, callback);
};

// http://www.elasticsearch.org/guide/reference/api/admin-indices-gateway-snapshot/
self.snapshot = function (options, callback) {
if (!callback && typeof options === 'function') {
callback = options;
Expand All @@ -487,6 +511,7 @@ module.exports = function (config, req, self) {
return req.post(options, callback);
};

// http://www.elasticsearch.org/guide/reference/api/admin-indices-stats/
self.stats = function (options, callback) {
if (!callback && typeof options === 'function') {
callback = options;
Expand All @@ -506,6 +531,7 @@ module.exports = function (config, req, self) {
return req.get(options, callback);
};

// http://www.elasticsearch.org/guide/reference/api/admin-indices-status/
self.status = function (options, callback) {
if (!callback && typeof options === 'function') {
callback = options;
Expand All @@ -523,6 +549,7 @@ module.exports = function (config, req, self) {
return req.get(options, callback);
};

// http://www.elasticsearch.org/guide/reference/api/admin-indices-templates/
self.templates = function (options, callback) {
if (!callback && typeof options === 'function') {
callback = options;
Expand All @@ -542,6 +569,7 @@ module.exports = function (config, req, self) {
return req.get(options, callback);
};

// http://www.elasticsearch.org/guide/reference/api/admin-indices-update-settings/
self.updateSettings = function (options, settings, callback) {
if (!callback && typeof settings === 'function') {
callback = settings;
Expand All @@ -559,6 +587,7 @@ module.exports = function (config, req, self) {
return req.put(options, settings, callback);
};

// http://www.elasticsearch.org/guide/reference/api/admin-indices-warmers/
self.warmers = function (options, callback) {
if (!callback && typeof options === 'function') {
callback = options;
Expand Down

0 comments on commit 014e853

Please sign in to comment.