mark idColumnName as a deprecated function

This commit is contained in:
Agnes Lin 2020-03-22 20:57:02 -04:00
parent 8919115439
commit 9fe64d412c
1 changed files with 7 additions and 1 deletions

View File

@ -2097,7 +2097,13 @@ DataSource.prototype.columnNames = function(modelName) {
};
/**
* Find the ID column name
* @deprecated
* Function to get the id column name of the target model
*
* For SQL connectors, use `SqlConnector.prototype.column(ModelDefinition.prototype.idName())`.
* For NoSQL connectors, use `Connector.prototype.idMapping(ModelDefinition.prototype.idName())`
* instead.
*
* @param {String} modelName The model name
* @returns {String} columnName for ID
*/