drizzle-orm Architecture Docs
Home / File/ index.ts — drizzle-orm Source File

index.ts — drizzle-orm Source File

Architecture documentation for index.ts, a typescript file in the drizzle-orm codebase. 3 imports, 9 dependents.

File typescript DrizzleKit Introspection 3 imports 9 dependents 1 functions

Entity Profile

Dependency Diagram

graph LR
  614b7cb0_0961_b6db_a581_7f7f04396b99["index.ts"]
  9135e6b6_37f7_c980_ee35_90f5531de5a4["common.ts"]
  614b7cb0_0961_b6db_a581_7f7f04396b99 --> 9135e6b6_37f7_c980_ee35_90f5531de5a4
  5e835bc2_6860_21e3_492c_babcc3e93529["schemaValidator.ts"]
  614b7cb0_0961_b6db_a581_7f7f04396b99 --> 5e835bc2_6860_21e3_492c_babcc3e93529
  d3c73027_0bad_40cc_f056_8db30b271a3d["tls"]
  614b7cb0_0961_b6db_a581_7f7f04396b99 --> d3c73027_0bad_40cc_f056_8db30b271a3d
  e668bfef_9125_1ef0_2f94_a0f9605584bd["api.ts"]
  e668bfef_9125_1ef0_2f94_a0f9605584bd --> 614b7cb0_0961_b6db_a581_7f7f04396b99
  5124f0e9_9356_c9d6_70c9_fd858361ee48["getTablesFilterByExtensions.ts"]
  5124f0e9_9356_c9d6_70c9_fd858361ee48 --> 614b7cb0_0961_b6db_a581_7f7f04396b99
  9a173f8e_79af_88f8_62fa_7021739a77bb["d1http.config.ts"]
  9a173f8e_79af_88f8_62fa_7021739a77bb --> 614b7cb0_0961_b6db_a581_7f7f04396b99
  92b9a29c_470a_3cad_b31d_f916528ae1cd["drizzle.config.ts"]
  92b9a29c_470a_3cad_b31d_f916528ae1cd --> 614b7cb0_0961_b6db_a581_7f7f04396b99
  25a114e2_7493_ab9a_1b8b_2787eec7dd9f["durable-sqlite.config.ts"]
  25a114e2_7493_ab9a_1b8b_2787eec7dd9f --> 614b7cb0_0961_b6db_a581_7f7f04396b99
  29b6540b_d4ea_ed84_d8b6_41fa13a28dc7["expo.config.ts"]
  29b6540b_d4ea_ed84_d8b6_41fa13a28dc7 --> 614b7cb0_0961_b6db_a581_7f7f04396b99
  82a070c3_ce77_e18e_7e8f_b77aec2b9771["postgres.config.ts"]
  82a070c3_ce77_e18e_7e8f_b77aec2b9771 --> 614b7cb0_0961_b6db_a581_7f7f04396b99
  a7d07618_22e3_f3aa_f0dd_463a1dc8bfbf["postgres2.config.ts"]
  a7d07618_22e3_f3aa_f0dd_463a1dc8bfbf --> 614b7cb0_0961_b6db_a581_7f7f04396b99
  46b8c5c1_e529_6dda_ce93_362e1f350add["turso.config.ts"]
  46b8c5c1_e529_6dda_ce93_362e1f350add --> 614b7cb0_0961_b6db_a581_7f7f04396b99
  style 614b7cb0_0961_b6db_a581_7f7f04396b99 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

import { ConnectionOptions } from 'tls';
import type { Driver, Prefix } from './cli/validations/common';
import type { Dialect } from './schemaValidator';

// import {SslOptions} from 'mysql2'
type SslOptions = {
	pfx?: string;
	key?: string;
	passphrase?: string;
	cert?: string;
	ca?: string | string[];
	crl?: string | string[];
	ciphers?: string;
	rejectUnauthorized?: boolean;
};

type Verify<T, U extends T> = U;

/**
 * **You are currently using version 0.21.0+ of drizzle-kit. If you have just upgraded to this version, please make sure to read the changelog to understand what changes have been made and what
 * adjustments may be necessary for you. See https://orm.drizzle.team/kit-docs/upgrade-21#how-to-migrate-to-0210**
 *
 * **Config** usage:
 *
 * `dialect` - mandatory and is responsible for explicitly providing a databse dialect you are using for all the commands
 * *Possible values*: `postgresql`, `mysql`, `sqlite`, `singlestore
 *
 * See https://orm.drizzle.team/kit-docs/config-reference#dialect
 *
 * ---
 * `schema` - param lets you define where your schema file/files live.
 * You can have as many separate schema files as you want and define paths to them using glob or array of globs syntax.
 *
 * See https://orm.drizzle.team/kit-docs/config-reference#schema
 *
 * ---
 * `out` - allows you to define the folder for your migrations and a folder, where drizzle will introspect the schema and relations
 *
 * See https://orm.drizzle.team/kit-docs/config-reference#out
 *
 * ---
 * `driver` - optional param that is responsible for explicitly providing a driver to use when accessing a database
 * *Possible values*: `aws-data-api`, `d1-http`, `expo`, `turso`, `pglite`
 * If you don't use AWS Data API, D1, Turso or Expo - ypu don't need this driver. You can check a driver strategy choice here: https://orm.drizzle.team/kit-docs/upgrade-21
 *
 * See https://orm.drizzle.team/kit-docs/config-reference#driver
 *
 * ---
 *
 * `dbCredentials` - an object to define your connection to the database. For more info please check the docs
 *
 * See https://orm.drizzle.team/kit-docs/config-reference#dbcredentials
 *
 * ---
 *
 * `migrations` - param let’s use specify custom table and schema(PostgreSQL only) for migrations.
 * By default, all information about executed migrations will be stored in the database inside
 * the `__drizzle_migrations` table, and for PostgreSQL, inside the drizzle schema.
 * However, you can configure where to store those records.
 *
// ... (290 more lines)

Domain

Subdomains

Functions

Types

Dependencies

Imported By

Source

Frequently Asked Questions

What does index.ts do?
index.ts is a source file in the drizzle-orm codebase, written in typescript. It belongs to the DrizzleKit domain, Introspection subdomain.
What functions are defined in index.ts?
index.ts defines 1 function(s): defineConfig.
What does index.ts depend on?
index.ts imports 3 module(s): common.ts, schemaValidator.ts, tls.
What files import index.ts?
index.ts is imported by 9 file(s): api.ts, d1http.config.ts, drizzle.config.ts, durable-sqlite.config.ts, expo.config.ts, getTablesFilterByExtensions.ts, postgres.config.ts, postgres2.config.ts, and 1 more.
Where is index.ts in the architecture?
index.ts is located at drizzle-kit/src/index.ts (domain: DrizzleKit, subdomain: Introspection, directory: drizzle-kit/src).

Analyze Your Own Codebase

Get architecture documentation, dependency graphs, and domain analysis for your codebase in minutes.

Try Supermodel Free