Merge pull request #1830 from strongloop/deprecated-idcol

mark idColumnName as deprecated
This commit is contained in:
Agnes Lin 2020-03-25 16:41:13 -04:00 committed by GitHub
commit df1c8dc00e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
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 * @param {String} modelName The model name
* @returns {String} columnName for ID * @returns {String} columnName for ID
*/ */