TypeORM-単純なプロジェクトの作成

この章では、簡単なTypeORMアプリケーションを作成する方法について説明します。'TypeORM'という名前の新しいディレクトリを作成し、そのディレクトリに移動しましょう。

cd /path/to/TypeORM/

構文

以下のコマンドを使用して、新しいプロジェクトを作成します-

typeorm init --name <project-name> --database <database-name>

例

typeorm init --name FirstProject --database mysql

ここに、

FirstProject あなたのプロジェクト名は sqlite3データベース名です。上記のコマンドを実行すると、次の応答が表示されます。

Project created inside /path/to/TypeORM/FirstProject directory

次に、プロジェクトディレクトリに移動し、を使用してプロジェクトの依存関係をインストールします npm モジュール、

$ cd FirstProject 

$ npm install

プロジェクト構造

新しく作成したプロジェクトのプロジェクト構造を理解しましょう。 FirstProject。

FirstProject 
├──> src 
│ ├──> entity 
│ │ └──> User.ts 
│ ├──> migration 
│ └──> index.ts 
├──> node_modules 
├──> ormconfig.json 
├──> package.json 
├──> package-lock.json 
└──> tsconfig.json

ここに、

src −アプリケーションのソースコードが含まれています TypeScript言語。ファイルがありますindex.ts および2つのサブディレクトリ entity そして migration。
index.ts −アプリケーションへのエントリポイント。
entity −データベースモデルが含まれています。
migration −データベース移行コードが含まれています。
node_modules −ローカルに保存されたnpmモジュール。
ormconfig.json−アプリケーションのメイン構成ファイル。データベース構成の詳細とエンティティ構成が含まれています。
package.json −ノードモジュールの依存関係が含まれます。
package-lock.json −自動生成されたファイルと関連 package.json。
tsconfig.json −TypeScript固有のコンパイラオプションが含まれています。

ormconfig.jsonファイル

アプリケーションで使用可能な構成オプションを確認しましょう。ormconfig.jsonファイルを開くと、次のようになります-

{ 
   "type": "mysql", 
   "host": "localhost", 
   "port": 3306, 
   "username": "test", 
   "password": "test", 
   "database": "test", 
   "synchronize": true, 
   "logging": false, 
   "entities": [ 
      "src/entity/**/*.ts" ], 
   "migrations": [ "src/migration/**/*.ts" 
   ], 
   "subscribers": [ "src/subscriber/**/*.ts" 
   ], 
   "cli": { 
      "entitiesDir":"src/entity", "migrationsDir":"src/migration", "subscribersDir":"src/subscriber
   }    
 }

ここに、

type、 host、 username、 password、 database およびポートオプションは、データベース設定に関連しています。 mysql 以下の構成を使用して構成できます-

{ 
   "type": "mysql", 
   "host": "localhost", 
   "port": 3306, 
   "username": "db_username", "password": "db_password", "database": "db_name" 
}

entities −エンティティクラスの場所を参照します。
migrations −移行クラスの場所を示します。
subscribers −サブスクライバークラスの場所を示します。
cli −によって使用されるオプションを参照します TypeORM CLI コードを自動生成するには

MySqlサーバーを起動します

アプリケーションを起動する前に、 MySQL サーバーまたはユーザーが使用するデータベースサーバーを使用して、正しく実行されていることを確認します。

アプリケーションを実行する

すべてが構成されたら、以下のコマンドを使用してアプリケーションを実行できます-

npm start

次の応答を見ることができます-

> [email protected] start /Users/../../TypeORM/FirstProject 

> ts-node src/index.ts 

Inserting a new user into the database... Saved a new user with id: 1 Loading users from the database... Loaded users: [ User { id: 1, firstName: 'Timber', lastName: 'Saw', age: 25 }] 

Here you can setup and run express/koa/any other framework.

アプリケーションは新しいユーザーをデータベースに挿入し、データベースから逆ロードして、最後にロードされたユーザーをコンソールに表示します。新しいものを作成しましたTypeORM アプリケーションを構成し、アプリケーションを実行します。

次の章では、データがどのように実行されるかについて詳しく説明します。