TypeORM - Création d'un projet simple

Ce chapitre explique comment créer une application TypeORM simple. Créons un nouveau répertoire nommé 'TypeORM' et allons dans le répertoire.

cd /path/to/TypeORM/

Syntaxe

Utilisez la commande ci-dessous pour créer un nouveau projet -

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

Exemple

typeorm init --name FirstProject --database mysql

Ici,

FirstProject est le nom de votre projet et sqlite3est le nom de la base de données. Après avoir exécuté la commande ci-dessus, vous pouvez voir la réponse suivante,

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

Maintenant, déplacez-vous dans notre répertoire de projet et installez les dépendances de projet en utilisant npm module,

$ cd FirstProject 

$ npm install

Structure du projet

Laissez-nous comprendre la structure du projet de notre projet nouvellement créé, FirstProject.

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

Ici,

  • src - contient le code source de votre application dans TypeScriptLangue. Il a un fichierindex.ts et deux sous répertoires entity et migration.
  • index.ts - Votre point d'entrée vers l'application.
  • entity - Contient des modèles de base de données.
  • migration - contient le code de migration de la base de données.
  • node_modules - modules npm enregistrés localement.
  • ormconfig.json- Fichier de configuration principal de votre application. Il contient les détails de configuration de la base de données et la configuration des entités.
  • package.json - Contient les dépendances du module de nœud.
  • package-lock.json - Fichier généré automatiquement et lié à package.json.
  • tsconfig.json - Contient les options du compilateur spécifiques à TypeScript.

fichier ormconfig.json

Vérifions l'option de configuration disponible pour notre application. Ouvrez le fichier ormconfig.json et il ressemble à ceci -

{ 
   "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
   }    
 }

Ici,

type, host, username, password, database et les options de port sont liées à la configuration de la base de données. mysql peut être configuré en utilisant la configuration ci-dessous -

{ 
   "type": "mysql", 
   "host": "localhost", 
   "port": 3306, 
   "username": "db_username", "password": "db_password", "database": "db_name" 
}
  • entities - fait référence à l'emplacement de vos classes d'entités.
  • migrations - fait référence à l'emplacement de vos classes de migration.
  • subscribers - fait référence à l'emplacement de vos classes d'abonnés.
  • cli - fait référence à l'option utilisée par TypeORM CLI pour générer automatiquement le code

Démarrer le serveur MySql

Avant de démarrer l'application, démarrez votre MySQL serveur ou tout autre serveur de base de données que vous utilisez et assurez-vous qu'il fonctionne correctement.

Lancer l'application

Une fois que tout est configuré, nous pouvons exécuter l'application en utilisant la commande ci-dessous -

npm start

Vous pouvez voir la réponse suivante -

> [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.

L'application a inséré un nouvel utilisateur dans la base de données, puis chargez-le à l'envers à partir de la base de données et affichez enfin l'utilisateur chargé dans la console. Nous avons créé avec succès un nouveauTypeORM application, l'a configuré et exécutez l'application.

Nous discuterons de la manière dont les données sont exécutées de manière détaillée dans les prochains chapitres.