Skip to content

Latest commit

聽

History

History
151 lines (105 loc) 路 6.18 KB

use-only-photon.md

File metadata and controls

151 lines (105 loc) 路 6.18 KB
Raw

Using only Photon (without Lift)

You can use Photon as an ORM in your application without using Lift for database migrations. This is useful for existing applications when there already is a working migration system or when you don't have the rights inside your organization to perform database migrations yourself.

When using Photon without Lift, you obtain your data model definition by introspecting your database schema and generating the Prisma data model from it. The generated data model then serves as foundation for Photon's generated CRUD API. Whenever a schema migration is performed on the database afterwards, you need to re-introspect your database (which updates your data model) and re-generate your Photon API.

This page is about using Photon with an existing database. Learn more about getting started from scratch with Photon and Lift here.

Getting started with Photon

1. Install the Prisma CLI

npm install -g prisma2

2. Set up project using prisma init

Run the following command to initialize a new project:

prisma init hello-world

Then follow the interactive prompt:

  1. Select Blank project
  2. Select your database type
    • SQLite
    • MySQL
    • PostgreSQL
    • MongoDB (coming soon)
  3. Provide your database credentials (more info)
  4. Select the database (MySQL) or schema (PostgreSQL) to introspect
  5. Select Only Photon (i.e. uncheck Lift using SPACE)
  6. Select your programming language
    • JavaScript
    • TypeScript
    • Go (coming soon)
  7. Select a Demo script or start with Just the Prisma schema

Once you're done with the interactive prompt, the CLI sets out for 3 major tasks:

  1. Introspecting your database schema
  2. Generating a data model based on the introspection
  3. Generating the Photon API in your selected language

Plus, if you've selected a boilerplate to get started, it downloads the boilerplate code and configures it to connect to your database and match the generated data model.

3. Integrate Photon in your application

To start using Photon in your application, you can import it from node_modules/@generated and start calling your database via the generated Photon API.

4. Customize your Photon API

One benefit of having the data model as an intermediate representation of your database schema is that lets you to decouple the database schema from your data access API. For example, you can map cryptic table names to friendlier model names to be used in your API.

For example, when the following model was generated for you through the introspection:

model _customers {
  id Int @id
  number_of_orders Int
}

By default, the generated API is based the model and fields names, e.g.:

await photon._customers.findMany({
  where: { number_of_orders: 5 }
})

You might prefer using camel casing rather than the snake case convention used in the database. You can therefore customize the mapping of a table/field name to a specific model/field name in the data model using the map attribute:

model Customer @@map(name: "_customers") {
  id Int @id
  orderCount Int @map(name: "number_of_orders")
}

After running another prisma2 generate, your Photon API now looks as follows:

await photon.customers.findMany({
  where: { orderCount: 5 }
})

5. Evolve your application

Whenever the database schema changes throughout the lifetime of your application, you need to re-generate your Photon API to ensure it still matches the underlying database structures. The workflow for that typically involves two steps:

  1. Re-introspecting your database schema to update the data model
  2. Re-generate your Photon API

In CLI commands, this looks as follows:

prisma2 introspect
prisma2 generate

Database credentials

Database credentials for SQLite
When using SQLite, you need to provide the _file path_ to your existing SQLite database file.
Database credentials for MySQL
When using MySQL, you need to provide the following information to connect your existing MySQL database server:
  • Host: The IP address/domain of your database server, e.g. localhost.
  • Post: The port on which your database server listens, e.g. 5432 (PostgreSQL) or 3306 (MySQL).
  • User: The database user, e.g. admin.
  • Password: The password for the database user.
  • SSL: Whether or not your database server uses SSL.

Once provided, the CLI will prompt you to select one of the existing databases on your MySQL server for introspection.

Database credentials for PostgreSQL
When using PostgreSQL, you need to provide the following information to connect your existing PostgreSQL database server:
  • Host: The IP address/domain of your database server, e.g. localhost.
  • Post: The port on which your database server listens, e.g. 5432 (PostgreSQL) or 3306 (MySQL).
  • Database: The name of the database which contains the schema to introspect.
  • User: The database user, e.g. admin.
  • Password: The password for the database user.
  • SSL: Whether or not your database server uses SSL.

Once provided, the CLI will prompt you to select one of the existing schemas on your PostgreSQL server for introspection.

Database credentials for MongoDB
When using MongoDB, you need to provide your [MongoDB connection string](https://docs.mongodb.com/manual/reference/connection-string), e.g. `http://user1:myPassword@localhost:27017/admin`. Note that this must include the database credentials as well as the [`authSource`](https://docs.mongodb.com/manual/reference/connection-string/#authentication-options) database that's storing the credentials of your MongoDB `admin` user (by default it is often called `admin`).

Demo scripts

When you're selecting the Demo script option, the Prisma 2 CLI will provide a simple, runnable Node.js/TypeScript that showcases usage of the Photon API and gives you a foundation for further exploration.