diff --git a/README.md b/README.md index 4c172fb1597a..b1f08da70422 100644 --- a/README.md +++ b/README.md @@ -45,7 +45,7 @@ Learn more about the `prisma2 init` flow [here](./docs/getting-started.md) or ge - Core - Connectors - [MySQL](./docs/core/connectors/mysql.md) - - [PostgreSQL](./docs/core/connectors/postgres.md) + - [PostgreSQL](./docs/core/connectors/postgresql.md) - [SQLite](./docs/core/connectors/sqlite.md) - [MongoDB](./docs/core/connectors/mongo.md) - Generators diff --git a/docs/README.md b/docs/README.md index 13f9250ae502..c9089e0162cf 100644 --- a/docs/README.md +++ b/docs/README.md @@ -14,7 +14,7 @@ - Core - Connectors - [MySQL](./core/connectors/mysql.md) - - [PostgreSQL](./core/connectors/postgres.md) + - [PostgreSQL](./core/connectors/postgresql.md) - [SQLite](./core/connectors/sqlite.md) - [MongoDB](./core/connectors/mongo.md) - Generators diff --git a/docs/core/connectors/postgres.md b/docs/core/connectors/postgresql.md similarity index 96% rename from docs/core/connectors/postgres.md rename to docs/core/connectors/postgresql.md index f7ba64a82550..6f33abaee3eb 100644 --- a/docs/core/connectors/postgres.md +++ b/docs/core/connectors/postgresql.md @@ -8,7 +8,7 @@ To connect to a PostgreSQL database server, you need to configure a [`datasource ```groovy datasource pg { - provider = "postgres" + provider = "postgresql" url = env("POSTGRES_URL") } @@ -64,7 +64,7 @@ postgresql://[user[:password]@][netloc][:port][,...][/database][?param1=value1&. - `host`: The IP address/domain of your database server, e.g. `localhost`. - `port`: The port on which your database server listens, e.g. `5432`. - `database`: The name of the database with the target schema. -- `schema`: The name of the target schema. +- `schema`: The name of the target schema. Default: `public`. - `user`: The database user, e.g. `admin`. - `password`: The password for the database user. - `ssl`: Whether or not your database server uses SSL. diff --git a/docs/core/generators/photonjs.md b/docs/core/generators/photonjs.md index 62841be8e141..ba3e9fd6c4ea 100644 --- a/docs/core/generators/photonjs.md +++ b/docs/core/generators/photonjs.md @@ -66,3 +66,16 @@ The Photon JS generator provides the following mapping from data model [scalar t | `Int` | `number` | | `Float` | `number` | | `Datetime` | `Date` | + +## Reserved model names + +When generating Photon JS based on your [data model definition](./data-modeling.md#data-model-definition), there are a number of reserved names that you can't use for your models. Here is a list of the reserved names: + +- `String` +- `Int` +- `Float` +- `Subscription` +- `DateTime` +- `WhereInput` +- `IDFilter` +- `StringFilter` \ No newline at end of file diff --git a/docs/data-modeling.md b/docs/data-modeling.md index 4f681e884a8c..a0b06ea63d9b 100644 --- a/docs/data-modeling.md +++ b/docs/data-modeling.md @@ -11,6 +11,7 @@ - [Functions](#functions) - [Scalar types](#scalar-types) - [Relations](#relations) +- [Reserved model names](#reserved-model-names) ## Data model definition @@ -374,7 +375,7 @@ _Connector_ attributes let you use the native features of your data source. With Here is where you can find the documentation of connector attributes per data source connector: - [MySQL](./core/connectors/mysql.md) -- [PostgreSQL](./core/connectors/postgres.md) +- [PostgreSQL](./core/connectors/postgresql.md) - [SQLite](./core/connectors/sqlite.md) - [MongoDB](./core/connectors/mongo.md) @@ -449,3 +450,17 @@ close. ## Relations Learn more about relations [here](./relations.md). + +## Reserved model names + +When generating Photon JS based on your [data model definition](./data-modeling.md#data-model-definition), there are a number of reserved names that you can't use for your models. Here is a list of the reserved names: + +- `String` +- `Int` +- `Float` +- `Subscription` +- `DateTime` +- `WhereInput` +- `IDFilter` +- `StringFilter` + diff --git a/docs/faq.md b/docs/faq.md index 2132b0edffbd..ae9c44d4ac57 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -31,7 +31,7 @@ Photon acts more as a _query builder_ returning plain objects with a focus on st ### Will Photon support more databases (and other data sources) in the future? -Yes. Photon is based on Prisma's query engine that can connect to any data source that provides a proper connector implementation. There will be built-in connectors such as the current ones for [PostgreSQL](./core/connectors/postgres.md), [MySQL](./core/connectors/mysql.md) and [SQLite](./core/connectors/sqlite.md). +Yes. Photon is based on Prisma's query engine that can connect to any data source that provides a proper connector implementation. There will be built-in connectors such as the current ones for [PostgreSQL](./core/connectors/postgresql.md), [MySQL](./core/connectors/mysql.md) and [SQLite](./core/connectors/sqlite.md). However, it's also possible to build your own connectors, more documentation on that topic will follow soon. diff --git a/docs/glossary.md b/docs/glossary.md index da0515e339ee..99a93e3f9571 100644 --- a/docs/glossary.md +++ b/docs/glossary.md @@ -47,7 +47,7 @@ A data source connector connects Prisma to a [data source](#data-source). Prisma currently supports the following built-in connectors: - [`sqlite`](./core/connectors/sqlite.md): A connector for SQLite databases -- [`postgres`](./core/connectors/postgres.md): A connector for PostgreSQL databases +- [`postgresql`](./core/connectors/postgresql.md): A connector for PostgreSQL databases - [`mysql`](./core/connectors/mysql.md): A connector for MySQL databases - [`mongo`](./core/connectors/mongo.md): A connector for MongoDB databases (_coming soon_) diff --git a/docs/photon/deployment.md b/docs/photon/deployment.md index 897e5203c3c3..7efaf5b30db4 100644 --- a/docs/photon/deployment.md +++ b/docs/photon/deployment.md @@ -28,3 +28,39 @@ Note that `darwin` is the default `target`. Here's a list of supported platforms | Google Cloud Functions | User's choice | > **ATTENTION**: The `target` field on the `generator` block is not yet implemented. You can track the progress of the implementation [on GitHub](https://github.com/prisma/prisma2/issues/97). You can also check ou the [specification](https://github.com/prisma/specs/tree/master/binary-workflows) for more details. + +## Hosting providers + +### ZEIT Now + +You can deploy your "Photon JS"-based application to [ZEIT Now](https://zeit.co/now). + +When deploying to ZEIT Now, you must configure the following in your `now.json`: + +- `use`: `@now/node@canary` +- `maxLambdaSize`: `25mb` + +Here is an example `now.json`: + +```json +{ + "version": 2, + "builds": [ + { + "src": "index.js", + "use": "@now/node@canary", + "config": { + "maxLambdaSize": "25mb" + } + } + ], + "routes": [ + { + "src": "/(.*)", + "dest": "index.js" + } + ] +} +``` + +You can find an example for a ZEIT Now deployment [here](https://github.com/prisma/photonjs/tree/master/examples/javascript/now). \ No newline at end of file diff --git a/docs/prisma-schema-file.md b/docs/prisma-schema-file.md index 912b9de1b081..737198ea6931 100644 --- a/docs/prisma-schema-file.md +++ b/docs/prisma-schema-file.md @@ -73,7 +73,7 @@ A data source can be specified using a `datasource` block in the schema file. | Name | Required | Type | Description | | --- | --- | --- | --- | -| `provider` | **Yes** | Enum (`postgres`, `mysql`, `sqlite`) | Describes which data source connector to use. | +| `provider` | **Yes** | Enum (`postgresql`, `mysql`, `sqlite`) | Describes which data source connector to use. | | `url` | **Yes** | String (URL) | Connection URL including authentication info. Each data source connector documents the URL syntax. Most connectors use the syntax provided by the database. | | `enabled` | No | Boolean | Use environment variables to enable/disable a data source. **Default**: `true`. | @@ -94,8 +94,8 @@ datasource mysql { url = env("SQLITE_URL") } -datasource postgres { - provider = "postgres" +datasource postgresql { + provider = "postgresql" url = env("SQLITE_URL") } @@ -112,7 +112,7 @@ This is just a general convention, technically data sources can be named anythin ```groovy datasource pg { - provider = "postgres" + provider = "postgresql" url = env("POSTGRES_URL") enabled = true } @@ -196,7 +196,7 @@ Environment variables can be provided using the `env` function: ``` datasource pg { - provider = "postgres" + provider = "postgresql" url = env("POSTGRES_URL") } ``` diff --git a/docs/prisma2-feedback.md b/docs/prisma2-feedback.md index 373b894c7871..0fa3aca0e238 100644 --- a/docs/prisma2-feedback.md +++ b/docs/prisma2-feedback.md @@ -62,8 +62,9 @@ Once you created a GitHub issue, feel free to post it in the [`#prisma2-preview` We are extremely eager to get your feedback! Please feel free to reach out to us personally during the Preview period if you can't find an appropriate place for your specific feedback. Email us +Email us Email us Email us Email us Email us -Email us \ No newline at end of file +Email us diff --git a/docs/tutorial.md b/docs/tutorial.md index 46c4fb4e29c7..1776752abf7f 100644 --- a/docs/tutorial.md +++ b/docs/tutorial.md @@ -113,18 +113,18 @@ Your Prisma schema file currently has the following contents: ```prisma datasource db { - provider = "postgres" + provider = "postgresql" url = "postgresql://USER:PASSWORD@HOST:PORT/DATABASE?schema=SCHEMA" } ``` The uppercase letters are placeholders representing your database credentials. -For a PostgreSQL database hosted on Heroku, the [connection string](./core/connectors/postgres.md#connection-string) might look as follows: +For a PostgreSQL database hosted on Heroku, the [connection string](./core/connectors/postgresql.md#connection-string) might look as follows: ```prisma datasource db { - provider = "postgres" + provider = "postgresql" url = "postgresql://opnmyfngbknppm:XXX@ec2-46-137-91-216.eu-west-1.compute.amazonaws.com:5432/d50rgmkqi2ipus?schema=hello-prisma2" } ``` @@ -133,7 +133,7 @@ When running PostgreSQL locally, your user and password as well as the database ```prisma datasource db { - provider = "postgres" + provider = "postgresql" url = "postgresql://johndoe:johndoe@localhost:5432/johndoe?schema=hello-prisma2" } ``` @@ -267,7 +267,7 @@ To generate Photon, you first need to add a `generator` to your schema file. Go ```diff datasource db { - provider = "postgres" + provider = "postgresql" url = "postgresql://USER:PASSWORD@HOST:PORT/DATABASE?schema=SCHEMA" } @@ -576,4 +576,4 @@ prisma2 lift up ## 9. Explore Photon's relation API -Coming soon. \ No newline at end of file +Coming soon. In the meantime, you can learn more about Photon's relations API [here](./relations.md#relations-in-the-generated-photon-api). \ No newline at end of file diff --git a/releases/README.md b/releases/README.md index 94773ace6a97..324709255d3f 100644 --- a/releases/README.md +++ b/releases/README.md @@ -1,17 +1,26 @@ # Releases +This page explains the release process for Prisma 2. + +## Release log + +- [`preview-1`](https://github.com/prisma/prisma/releases/tag/2.0.0-preview-1) (July 11, 2019) +- `preview-2` (July 18, 2019) + ## Release channels There are two main release channels: - **Preview**: Weekly releases on Thursdays -- **Alpha**: Rolling releases +- **Alpha**: Rolling/continuous releases Unless you have specific requirements for the alpha channel, it is recommended to always use the latest Preview release. ### Preview -Prisma 2 has a **weekly release cycle** where new Preview releases are issued **on Thursdays**. Preview releases are named `preview-1`, `preview-2`, `preview-3`, ... +Prisma 2 has a **weekly release cycle** where new Preview releases are issued **on Thursdays**. + +Preview releases are named `2.0.0-preview-1`, `2.0.0-preview-2`, `2.0.0-preview-3`, ... or you can reference them for short: `preview-1`, `preview-2`, `preview-3` ... You can install the latest Preview release via npm: @@ -29,4 +38,4 @@ You can install the latest alpha release via npm: ``` npm install -g prisma2@alpha -``` \ No newline at end of file +```