{"_id":"@cg10036/kysely-clickhouse","name":"@cg10036/kysely-clickhouse","dist-tags":{"latest":"1.5.1"},"versions":{"1.5.1":{"name":"@cg10036/kysely-clickhouse","version":"1.5.1","description":"Clickhouse Dialect for Kysely","main":"./dist/index.js","types":"./dist/index.d.ts","repository":{"type":"git","url":"git+https://github.com/cg10036/kysely-clickhouse.git"},"scripts":{"prepare":"tsc","test":"vitest","build":"tsc"},"keywords":["kysely","clickhouse"],"author":{"name":"Makara Sok"},"license":"MIT","devDependencies":{"@biomejs/biome":"^1.5.2","@clickhouse/client":"^1.4.1","@types/bluebird":"^3.5.42","@types/node":"^22.14.0","kysely":"^0.27.2","typescript":"^5.3.3","vitest":"^1.2.1"},"peerDependencies":{"@clickhouse/client":"*","kysely":"*"},"dependencies":{"bluebird":"^3.7.2"},"_id":"@cg10036/kysely-clickhouse@1.5.1","gitHead":"c2131f0759059bdf5348ae780fdd174a604239df","bugs":{"url":"https://github.com/cg10036/kysely-clickhouse/issues"},"homepage":"https://github.com/cg10036/kysely-clickhouse#readme","_nodeVersion":"22.12.0","_npmVersion":"10.9.0","dist":{"integrity":"sha512-zuXjBbmxVaruPHdwx+b5talmvQC2vFjeLNtSikiD//npX5zE0LK/VDxpaCAux5nseeSCcl8RlcTII3hk+KDFhw==","shasum":"fcd6afeb11c367ed89a3a657e65c69d26da230f5","tarball":"https://registry.npmjs.org/@cg10036/kysely-clickhouse/-/kysely-clickhouse-1.5.1.tgz","fileCount":14,"unpackedSize":14540,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIHYa7YN7YHabmnwUCAGri/I1JIOccB+F3uviTtcypdEMAiEAmeQ7ROK7x8qtcnApJ3g3ZLqbu2U8nyhFn5znAfmpsbo="}]},"_npmUser":{"name":"cg10036","email":"cg10036@gmail.com"},"directories":{},"maintainers":[{"name":"cg10036","email":"cg10036@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/kysely-clickhouse_1.5.1_1744338263416_0.6464742289808598"},"_hasShrinkwrap":false}},"time":{"created":"2025-04-11T02:24:23.330Z","1.5.1":"2025-04-11T02:24:23.580Z","modified":"2025-04-11T02:24:24.088Z"},"maintainers":[{"name":"cg10036","email":"cg10036@gmail.com"}],"description":"Clickhouse Dialect for Kysely","homepage":"https://github.com/cg10036/kysely-clickhouse#readme","keywords":["kysely","clickhouse"],"repository":{"type":"git","url":"git+https://github.com/cg10036/kysely-clickhouse.git"},"author":{"name":"Makara Sok"},"bugs":{"url":"https://github.com/cg10036/kysely-clickhouse/issues"},"license":"MIT","readme":"# @cg10036/kysely-clickhouse\n\n[Kysely](https://github.com/koskimas/kysely) adapter for [Clickhouse](https://clickhouse.com).\n\n```bash\nnpm i @clickhouse/client @founderpath/kysely-clickhouse\n```\n\nThis project was largely adapted from [kysely-planetscale](https://github.com/depot/kysely-planetscale). It's a barebone version, there's a lot of improvements that can be done here. \n\n## Usage\n\nPass your Clickhouse connection options into the dialect in order to configure the Kysely client. Follow [these docs](https://www.npmjs.com/package/@clickhouse/client) for instructions on how to do so.\n\n```typescript\nimport { Kysely } from 'kysely';\nimport { ClickhouseDialect } from '@founderpath/kysely-clickhouse';\n\ninterface SomeTable {\n  key: string;\n  value: string;\n}\n\ninterface Database {\n  some_datasets.some_table: SomeTable\n}\n\nconst db = new Kysely<Database>({ dialect: new ClickhouseDialect() });\n```\n\n","readmeFilename":"README.md","_rev":"1-f74cbbb0fb0d54f88cdc12b924bc3c7f"}