| import { Knex } from 'knex' | |
| export async function up(knex: Knex): Promise<any> { | |
| await knex.schema.createTable('test_setup', (table: Knex.TableBuilder) => { | |
| table.integer('foobar'); | |
| }); | |
| } | |
| export async function down(knex: Knex): Promise<any> { | |
| await knex.schema.dropTable('test_setup'); | |
| } |
| import { Knex } from "knex"; | |
| const config: Knex.Config = { | |
| client: "pg", | |
| connection: { | |
| connectionString: process.env.DATABASE_URL, | |
| timezone: "utc", | |
| }, | |
| pool: { | |
| min: 2, | |
| max: 10, | |
| }, | |
| migrations: { | |
| tableName: "knex_migrations", | |
| directory: "migrations", | |
| }, | |
| }; | |
| export default config; |
| { | |
| "name": "my-app", | |
| "version": "0.0.1", | |
| "description": "", | |
| "main": "src/server.js", | |
| "private": true, | |
| "scripts": { | |
| "knex:migrate:make": "knex --knexfile src/database/knexfile.ts migrate:make -x ts", | |
| "knex:migrate:latest": "knex --knexfile src/database/knexfile.ts migrate:latest", | |
| "knex:migrate:rollback": "knex --knexfile src/database/knexfile.ts migrate:rollback" | |
| }, | |
| "dependencies": { | |
| "knex": "^0.95.6", | |
| "pg": "^8.6.0", | |
| "ts-node": "^9.1.1", | |
| "typescript": "^4.2.4" | |
| } | |
| } |
Make sure you have ts-node installed: npm install ts-node
This creates a .ts file in migrations directory
npm run knex:migrate:make -- some-migration-name
npm run knex:migrate:latest
npm run knex:migrate:rollback
knexfile.ts requires require('ts-node/register'); to work.require()s
For anyone encountering the "unknown option '-x'" issue, i solved this by doing the following in the package.json scripts
"knex": "./node_modules/.bin/knex --knexfile src/my/path/to/database/knexfile.ts"
Now i can use it like so:
npm run knex migrate:make some_migration
@acbd-ca try:
import 'dotenv/config'
Hey @tukkajukka, how would you import the knexfile config into your ts src files to actually use the config? Also, how do you avoid placing DB creds into GitHub with this? Should knexfile fetch from envvars?
@HamishWHC environment variables is the way to go with any credentials, e.g. process.env.DATABASE_URL reads database credentials from env vars.
Did you try importing the Knexfile with require() or ES6 import?
If you still have the "-x" issue, explanation is simple, there's a mistake in the gist.
Instead of doing "knex -x ts migrate:make migration_name" you need to do "knex migrate:make -x ts migration_name".
My script works like this:
// package.json script:
"knex:migrate:make": "knex --knexfile src/knexfile.ts migrate:make -x ts",
// in terminal:
npm run knex:migrate:make migration_name
@grumd thanks, updated.
In the migration file I'm getting this error Cannot use namespace Knex as a type
In the migration file I'm getting this error
Cannot use namespace Knex as a type
Knex typings changed. Try the following:
import { Knex } from 'knex'
In the migration file I'm getting this error
Cannot use namespace Knex as a typeKnex typings changed. Try the following:
import { Knex } from 'knex'
Thanks, that works.
Now you can specify to knex generate ts files on knexfile.ts.
const config: Knex.Config = {
client: 'pg',
connection: {
host: 'localhost',
user: 'postgres'
},
migrations: {
extension: 'ts', //define work typescript to migrations
directory: 'src/knex/migrations',
tableName: 'migrations_history',
},
seeds: {
extension: 'ts', //define work typescript to seeds
directory: 'src/knex/seeds',
},
};This makes it easier than always to specifying the -x ts flag.
In case you're interested, I set up this example project: https://github.com/jfollmann/knex-migrations-ts
Thank you for sharing this note.
[SOLVED]: npm install ts-node
and then try to run knex migrations
[SOLVED]: npm install ts-node
and then try to run knex migrations
[SOLVED]: npm install ts-node and then try to run knex migrations
Finally the ONLY working solution that I found :/
Wasted like ~2+ hours to find this, thank you
@sahina For me this was fixed by changing a property in my tsconfig.
"module"was set to"esnext"and I changed it to"commonjs"and then it worked.