archive-gh-me/typeorm
1
0
Fork 0
mirror of https://github.com/typeorm/typeorm.git synced 2025-12-08 21:26:23 +00:00
Code Issues Projects Releases Wiki Activity

docs: fix grammar issues in README (#8282)

Browse Source 
Fixed some grammar mistakes
This commit is contained in:
Sagar Yadav 2021-10-18 23:16:04 +05:30 committed by GitHub
parent 861573377b
commit b6c828cc6c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 23 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
README.md
View File

@ -215,7 +215,7 @@ await timber.remove();
npm i hdb-pool
```
*SAP Hana support made possible by sponsorship of [Neptune Software](https://www.neptune-software.com/).*
*SAP Hana support made possible by the sponsorship of [Neptune Software](https://www.neptune-software.com/).*
* for **MongoDB** (experimental)
@ -327,7 +327,7 @@ creating more entities.
> You can generate an even more advanced project with express installed by running
`typeorm init --name MyProject --database mysql --express` command.
> You can generate docker-compose file by running
> You can generate a docker-compose file by running
`typeorm init --name MyProject --database postgres --docker` command.
## Step-by-Step Guide
@ -336,7 +336,7 @@ What are you expecting from ORM?
First of all, you are expecting it will create database tables for you
and find / insert / update / delete your data without the pain of
having to write lots of hardly maintainable SQL queries.
This guide will show you how to setup TypeORM from scratch and make it do what you are expecting from an ORM.
This guide will show you how to set up TypeORM from scratch and make it do what you are expecting from an ORM.
### Create a model
@ -359,7 +359,7 @@ export class Photo {
```
And you want to store photos in your database.
To store things in the database, first you need a database table,
To store things in the database, first, you need a database table,
and database tables are created from your models.
Not all models, but only those you define as *entities*.
@ -387,7 +387,7 @@ export class Photo {
```
Now, a database table will be created for the `Photo` entity and we'll be able to work with it anywhere in our app.
We have created a database table, however what table can exist without columns?
We have created a database table, however, what table can exist without columns?
Let's create a few columns in our database table.
### Adding table columns
@ -433,7 +433,7 @@ Each database table must have a column with a primary key.
Each entity **must** have at least one primary key column.
This is a requirement and you can't avoid it.
To make a column a primary key, you need to use `@PrimaryColumn` decorator.
To make a column a primary key, you need to use the `@PrimaryColumn` decorator.
```typescript
import { Entity, Column, PrimaryColumn } from "typeorm";
@ -461,7 +461,7 @@ export class Photo {
}
```
### Creating an auto generated column
### Creating an auto-generated column
Now, let's say you want your id column to be auto-generated (this is known as auto-increment / sequence / serial / generated identity column).
To do that, you need to change the `@PrimaryColumn` decorator to a `@PrimaryGeneratedColumn` decorator:
@ -494,8 +494,8 @@ export class Photo {
### Column data types
Next, let's fix our data types. By default, string is mapped to a varchar(255)-like type (depending on the database type).
Number is mapped to a integer-like type (depending on the database type).
Next, let's fix our data types. By default, the string is mapped to a varchar(255)-like type (depending on the database type).
The number is mapped to an integer-like type (depending on the database type).
We don't want all our columns to be limited varchars or integers.
Let's setup correct data types:
@ -571,7 +571,7 @@ Setting `synchronize` makes sure your entities will be synced with the database,
### Loading all entities from the directory
Later, when we create more entities we need to add them to the entities in our configuration.
This is not very convenient, so instead we can set up the whole directory, from where all entities will be connected and used in our connection:
This is not very convenient, so instead, we can set up the whole directory, from where all entities will be connected and used in our connection:
```typescript
import { createConnection } from "typeorm";
@ -594,14 +594,14 @@ createConnection({
But be careful with this approach.
If you are using `ts-node` then you need to specify paths to `.ts` files instead.
If you are using `outDir` then you'll need to specify paths to `.js` files inside outDir directory.
If you are using `outDir` then you'll need to specify paths to `.js` files inside the outDir directory.
If you are using `outDir` and when you remove or rename your entities make sure to clear `outDir` directory
and re-compile your project again, because when you remove your source `.ts` files their compiled `.js` versions
aren't removed from output directory and still are loaded by TypeORM because they are present in the `outDir` directory.
### Running the application
Now if you run your `index.ts`, a connection with database will be initialized and a database table for your photos will be created.
Now if you run your `index.ts`, a connection with the database will be initialized and a database table for your photos will be created.
```shell
@ -801,7 +801,7 @@ Now photo with `id = 1` will be removed from the database.
### Creating a one-to-one relation
Let's create a one-to-one relation with another class.
Let's create a one-to-one relationship with another class.
Let's create a new class in `PhotoMetadata.ts`. This PhotoMetadata class is supposed to contain our photo's additional meta-information:
```typescript
@ -901,7 +901,7 @@ createConnection(/*...*/).then(async connection => {
await metadataRepository.save(metadata);
// done
console.log("Metadata is saved, and relation between metadata and photo is created in the database too");
console.log("Metadata is saved, and the relation between metadata and photo is created in the database too");
}).catch(error => console.log(error));
```
@ -949,7 +949,7 @@ Here we show that the metadata property of the Photo class is where we store Pho
Instead of passing a function that returns a property of the photo, you could alternatively simply pass a string to `@OneToOne` decorator, like `"metadata"`.
But we used this function-typed approach to make our refactoring easier.
Note that we should use `@JoinColumn` decorator only on one side of a relation.
Note that we should use the `@JoinColumn` decorator only on one side of a relation.
Whichever side you put this decorator on will be the owning side of the relationship.
The owning side of a relationship contains a column with a foreign key in the database.
@ -998,14 +998,14 @@ createConnection(/*...*/).then(async connection => {
}).catch(error => console.log(error));
```
`QueryBuilder` allows creation and execution of SQL queries of almost any complexity.
`QueryBuilder` allows the creation and execution of SQL queries of almost any complexity.
When you work with `QueryBuilder`, think like you are creating an SQL query.
In this example, "photo" and "metadata" are aliases applied to selected photos.
You use aliases to access columns and properties of the selected data.
### Using cascades to automatically save related objects
We can setup cascade options in our relations, in the cases when we want our related object to be saved whenever the other object is saved.
We can set up cascade options in our relations, in the cases when we want our related object to be saved whenever the other object is saved.
Let's change our photo's `@OneToOne` decorator a bit:
```typescript
@ -1057,7 +1057,7 @@ Notice that we now set the photo's `metadata` property, instead of the metadata'
### Creating a many-to-one / one-to-many relation
Let's create a many-to-one / one-to-many relation.
Let's create a many-to-one/one-to-many relation.
Let's say a photo has one author, and each author can have many photos.
First, let's create an `Author` class:
@ -1080,7 +1080,7 @@ export class Author {
```
`Author` contains an inverse side of a relation.
`OneToMany` is always an inverse side of relation, and it can't exist without `ManyToOne` on the other side of the relation.
`OneToMany` is always an inverse side of the relation, and it can't exist without `ManyToOne` on the other side of the relation.
Now let's add the owner side of the relation into the Photo entity:
@ -1255,10 +1255,10 @@ let photos = await connection
```
This query selects all published photos with "My" or "Mishka" names.
It will select results from position 5 (pagination offset),
It will select results from position 5 (pagination offset)
and will select only 10 results (pagination limit).
The selection result will be ordered by id in descending order.
The photo's albums will be left-joined and their metadata will be inner joined.
The photo's albums will be left joined and their metadata will be inner joined.
You'll use the query builder in your application a lot.
Learn more about QueryBuilder [here](./docs/select-query-builder.md).
@ -1306,12 +1306,12 @@ This project exists thanks to all the people who contribute:
## Sponsors
Open source is hard and time-consuming. If you want to invest into TypeORM's future you can become a sponsor and allow our core team to spend more time on TypeORM's improvements and new features. [Become a sponsor](https://opencollective.com/typeorm)
Open source is hard and time-consuming. If you want to invest in TypeORM's future you can become a sponsor and allow our core team to spend more time on TypeORM's improvements and new features. [Become a sponsor](https://opencollective.com/typeorm)
<a href="https://opencollective.com/typeorm" target="_blank"><img src="https://opencollective.com/typeorm/tiers/sponsor.svg?width=890"></a>
## Gold Sponsors
Become a gold sponsor and get a premium technical support from our core contributors. [Become a gold sponsor](https://opencollective.com/typeorm)
Become a gold sponsor and get premium technical support from our core contributors. [Become a gold sponsor](https://opencollective.com/typeorm)
<a href="https://opencollective.com/typeorm" target="_blank"><img src="https://opencollective.com/typeorm/tiers/gold-sponsor.svg?width=890"></a>