MySQL Data Access Layer package for TradeMap4You projects.
npm install tmap-mysqlbash
npm install tmap-mysql
`
$3
For local testing and development, use npm link:
1. In the package directory (TradeMap4You.JSPackages/DataAccess/MySql):
`bash
npm link
`
This creates a global symlink to this package.
2. In your project directory (e.g., TradeMap4You.AL.API):
`bash
npm link tmap-mysql
`
This links the local package to your project.
3. To unlink (when switching to published version):
`bash
npm unlink tmap-mysql
npm install tmap-mysql
`
Usage
`javascript
const MySqlDO = require('tmap-mysql');
const config = require('./config');
const dataRepo = new MySqlDO(config.mysqlConString);
// Example usage
const result = await dataRepo.executeQuery('SELECT * FROM users WHERE id = ?', [1]);
`
Development
$3
`bash
npm run build
`
This builds the package using esbuild and outputs to dist/index.js.
$3
Before publishing, ensure:
1. ✅ Version is updated in package.json
2. ✅ Package is built (npm run build)
3. ✅ You're logged into npm (npm login)
4. ✅ Package name is available (if first time publishing)
To publish:
`bash
npm publish
`
Note: The prepublishOnly script will automatically build the package before publishing.
$3
- Patch version (1.0.6 → 1.0.7): Bug fixes
- Minor version (1.0.6 → 1.1.0): New features, backward compatible
- Major version (1.0.6 → 2.0.0): Breaking changes
Update version in package.json before publishing.
API Methods
- executeQuery(query, params) - Execute parameterized query
- getQueryResult(query) - Execute raw query
- getTableData(tableName) - Get all data from a table
- executeMultipleQuery(queryCollection) - Execute multiple queries
- InsertRowFromData(tableName, data) - Insert single row
- BulkInsertFromJson(tableName, jsonData) - Bulk insert from JSON
- getPoolStatus() - Get connection pool status
- testConnection() - Test database connection
- closePool()` - Close connection pool (call on app shutdown)