Jessie Beech
    • Create new note
    • Create a note from template
      • Sharing URL Link copied
      • /edit
      • View mode
        • Edit mode
        • View mode
        • Book mode
        • Slide mode
        Edit mode View mode Book mode Slide mode
      • Customize slides
      • Note Permission
      • Read
        • Only me
        • Signed-in users
        • Everyone
        Only me Signed-in users Everyone
      • Write
        • Only me
        • Signed-in users
        • Everyone
        Only me Signed-in users Everyone
      • Engagement control Commenting, Suggest edit, Emoji Reply
    • Invite by email
      Invitee

      This note has no invitees

    • Publish Note

      Share your work with the world Congratulations! 🎉 Your note is out in the world Publish Note

      Your note will be visible on your profile and discoverable by anyone.
      Your note is now live.
      This note is visible on your profile and discoverable online.
      Everyone on the web can find and read all notes of this public team.
      See published notes
      Unpublish note
      Please check the box to agree to the Community Guidelines.
      View profile
    • Commenting
      Permission
      Disabled Forbidden Owners Signed-in users Everyone
    • Enable
    • Permission
      • Forbidden
      • Owners
      • Signed-in users
      • Everyone
    • Suggest edit
      Permission
      Disabled Forbidden Owners Signed-in users Everyone
    • Enable
    • Permission
      • Forbidden
      • Owners
      • Signed-in users
    • Emoji Reply
    • Enable
    • Versions and GitHub Sync
    • Note settings
    • Note Insights
    • Engagement control
    • Transfer ownership
    • Delete this note
    • Save as template
    • Insert from template
    • Import from
      • Dropbox
      • Google Drive
      • Gist
      • Clipboard
    • Export to
      • Dropbox
      • Google Drive
      • Gist
    • Download
      • Markdown
      • HTML
      • Raw HTML
Menu Note settings Versions and GitHub Sync Note Insights Sharing URL Create Help
Create Create new note Create a note from template
Menu
Options
Engagement control Transfer ownership Delete this note
Import from
Dropbox Google Drive Gist Clipboard
Export to
Dropbox Google Drive Gist
Download
Markdown HTML Raw HTML
Back
Sharing URL Link copied
/edit
View mode
  • Edit mode
  • View mode
  • Book mode
  • Slide mode
Edit mode View mode Book mode Slide mode
Customize slides
Note Permission
Read
Only me
  • Only me
  • Signed-in users
  • Everyone
Only me Signed-in users Everyone
Write
Only me
  • Only me
  • Signed-in users
  • Everyone
Only me Signed-in users Everyone
Engagement control Commenting, Suggest edit, Emoji Reply
  • Invite by email
    Invitee

    This note has no invitees

  • Publish Note

    Share your work with the world Congratulations! 🎉 Your note is out in the world Publish Note

    Your note will be visible on your profile and discoverable by anyone.
    Your note is now live.
    This note is visible on your profile and discoverable online.
    Everyone on the web can find and read all notes of this public team.
    See published notes
    Unpublish note
    Please check the box to agree to the Community Guidelines.
    View profile
    Engagement control
    Commenting
    Permission
    Disabled Forbidden Owners Signed-in users Everyone
    Enable
    Permission
    • Forbidden
    • Owners
    • Signed-in users
    • Everyone
    Suggest edit
    Permission
    Disabled Forbidden Owners Signed-in users Everyone
    Enable
    Permission
    • Forbidden
    • Owners
    • Signed-in users
    Emoji Reply
    Enable
    Import from Dropbox Google Drive Gist Clipboard
       owned this note    owned this note      
    Published Linked with GitHub
    Subscribed
    • Any changes
      Be notified of any changes
    • Mention me
      Be notified of mention me
    • Unsubscribe
    Subscribe
    # Database Setup Cheatsheet [TOC] ## Creating a database on the command line: 1) Open up your client: ```shell= pgcli ``` 2) Decide on a good name. I'm going to use '**superbase**' 😎 2) inside your pgcli/psql shell run this command: ```SQL CREATE DATABASE superbase; ``` 3) Grant all priviledges on the database to your preferred user ```SQL GRANT ALL PRIVILEGES ON DATABASE superbase TO jessie; ``` ## Adding your database url to your config.env Put the `config.env` file in the root and **make sure it’s in your gitignore** Follow this pattern:
 ``` DB_URL = postgres://jessie:password@localhost:5432/superbase ``` + **no semicolon at the end** + **change the username, password AND database to your own** ## Filling your database with stuff (i.e. tables) 1. Write some nice SQL to create tables and insert some data. Put this in a file called `db_build.sql ` (ideally in `src/database`) 2. You now have 2 options. #### Proper way: a) Write your `db_connection.js` file. You will need this to write the build script, and in the rest of your app. b) Write a `db_build.js` file that runs the SQL. You will need this anyway for writing tests so you might as well do it in setup. c) Run the build file in your terminal (NOT inside psql/pgcl - just regular terminal): ```sh node src/database/db_build.js ``` ^or whatever the path is to your file from where you are. d) Rectify any errors (it usually tells you where the error was) #### Quick hacky way: a) Connect to your database ```sh pgcli superbase ``` (or if you are already in pgcli/psql) ```sh \c superbase ``` b) Copy paste all that SQL into the shell. c) Rectify any errors (it usually tells you where the error was) ### Whichever route you do: 3. Check it worked! ```sql SELECT * FROM hobbies; ``` or `\d` will give you a list of tables in the database you are connected to ## Setting up a separate TEST Database You can use your local database as a test database, if you want. But it will get wiped every time you run your tests. If you want to add a special test DB, it’s a lot like setting up a normal database. 1. Follow the first section in this sheet - [Creating a database on the command line](#Creating-a-database-on-the-command-line) - but give the database a different name, like **superbaseTest** 😎 2. Add the new url to your config.env - so you have TWO! ``` TEST_DB_URL = postgres://jessie:password@localhost:5432/superbaseTest ``` 3. Adapt your `db_connection.js` file to use the right database url in the right situation (test vs running local). [This workshop](https://github.com/foundersandcoders/ws-database-testing/) has a reminder! 4. You’re ready to rock and roll with tests. Checkout [this workshop](https://github.com/foundersandcoders/ws-database-testing/) if you cannot remember how to write a database test! ## Setting up a HEROKU Database [This workshop](https://github.com/foundersandcoders/db-morning-challenge) has great instructions on how to set up a database on heroku. Only one person per team needs to add this. When building the tables _inside_ the database, you may need to temporarily adapt the `db_connection.js` file to use the URL generated by heroku, before running `node src/database/db_build.js`. This url can be found easily in the dashboard > settings > config vars. You only need to run this build once! Make sure you’re working with your local database or test url after you’ve done this. Ask a mentor if you’re stuck! ## Getting Travis to pass your database tests! If you want to use travis, you need configure it to build it’s own databases so it can access them in the tests! You should use put a `.travis.yml` file into the root of your project, set up like this. ```yml services: - postgresql env: - DB=postgres - DB_URL=postgres://admin:password@localhost:5432/superbase - TEST_DB_URL=postgres://admin:password@localhost:5432/superbaseTest language: node_js node_js : - "node" after_success: npm run coverage before_script: - psql -c "CREATE DATABASE superbase;" -U postgres - psql -c "CREATE DATABASE superbaseTest;" -U postgres - psql -c "CREATE USER admin WITH PASSWORD 'password';" -U postgres - psql -c "ALTER DATABASE superbase OWNER TO admin;" -U postgres - psql -c "ALTER DATABASE superbaseTest OWNER to admin;" -U postgres ``` **Some checks when copy pasting the above!** + This file sets separate DB_URL and TEST_DB_URL environment variables. Check you’re using those _same variable names_ in your db_connection and config.env. If you’ve called your variables different things (or only have one) e.g. you used DB_TEST_URL instead of TEST_DB_URL - amend the yml file so they're the same. * Remove the line `after_success: npm run coverage` if you don’t have a ‘coverage’ script in your package.json ## Useful PSQL Resources - [TutorialsPoint](https://www.tutorialspoint.com/sql/index.htm) - probably the easiest to navigate - [PostgreSQL Tutorial](http://www.postgresqltutorial.com/) - also easy to navigate and the nicest to look at - [PostgreSQL Documentaion Version-11](https://www.postgresql.org/docs/11/sql.html) - The actual documentaion, great if you want more detail and up-to-date info - but a bit hard to look through. - You probably want Section "7.Queries" but other sections are also useful - Section "8.Data Types" should be useful for writing your db_build.sql file - [PostgreSQL Exercises](https://pgexercises.com/gettingstarted.html) - Great place to practice SQL queries - Similar excercises to the query workshops but with more thorough explanation of answers and helpful schema diagrams

    Import from clipboard

    Paste your markdown or webpage here...

    Advanced permission required

    Your current role can only read. Ask the system administrator to acquire write and comment permission.

    This team is disabled

    Sorry, this team is disabled. You can't edit this note.

    This note is locked

    Sorry, only owner can edit this note.

    Reach the limit

    Sorry, you've reached the max length this note can be.
    Please reduce the content or divide it to more notes, thank you!

    Import from Gist

    Import from Snippet

    or

    Export to Snippet

    Are you sure?

    Do you really want to delete this note?
    All users will lose their connection.

    Create a note from template

    Create a note from template

    Oops...
    This template has been removed or transferred.
    Upgrade
    All
    • All
    • Team
    No template.

    Create a template

    Upgrade

    Delete template

    Do you really want to delete this template?
    Turn this template into a regular note and keep its content, versions, and comments.

    This page need refresh

    You have an incompatible client version.
    Refresh to update.
    New version available!
    See releases notes here
    Refresh to enjoy new features.
    Your user state has changed.
    Refresh to load new user state.

    Sign in

    Forgot password

    or

    By clicking below, you agree to our terms of service.

    Sign in via Facebook Sign in via Twitter Sign in via GitHub Sign in via Dropbox Sign in with Wallet
    Wallet ( )
    Connect another wallet

    New to HackMD? Sign up

    Help

    • English
    • 中文
    • Français
    • Deutsch
    • 日本語
    • Español
    • Català
    • Ελληνικά
    • Português
    • italiano
    • Türkçe
    • Русский
    • Nederlands
    • hrvatski jezik
    • język polski
    • Українська
    • हिन्दी
    • svenska
    • Esperanto
    • dansk

    Documents

    Help & Tutorial

    How to use Book mode

    Slide Example

    API Docs

    Edit in VSCode

    Install browser extension

    Contacts

    Feedback

    Discord

    Send us email

    Resources

    Releases

    Pricing

    Blog

    Policy

    Terms

    Privacy

    Cheatsheet

    Syntax Example Reference
    # Header Header 基本排版
    - Unordered List
    • Unordered List
    1. Ordered List
    1. Ordered List
    - [ ] Todo List
    • Todo List
    > Blockquote
    Blockquote
    **Bold font** Bold font
    *Italics font* Italics font
    ~~Strikethrough~~ Strikethrough
    19^th^ 19th
    H~2~O H2O
    ++Inserted text++ Inserted text
    ==Marked text== Marked text
    [link text](https:// "title") Link
    ![image alt](https:// "title") Image
    `Code` Code 在筆記中貼入程式碼
    ```javascript
    var i = 0;
    ```
    var i = 0;
    :smile: :smile: Emoji list
    {%youtube youtube_id %} Externals
    $L^aT_eX$ LaTeX
    :::info
    This is a alert area.
    :::

    This is a alert area.

    Versions and GitHub Sync
    Get Full History Access

    • Edit version name
    • Delete

    revision author avatar     named on  

    More Less

    Note content is identical to the latest version.
    Compare
      Choose a version
      No search result
      Version not found
    Sign in to link this note to GitHub
    Learn more
    This note is not linked with GitHub
     

    Feedback

    Submission failed, please try again

    Thanks for your support.

    On a scale of 0-10, how likely is it that you would recommend HackMD to your friends, family or business associates?

    Please give us some advice and help us improve HackMD.

     

    Thanks for your feedback

    Remove version name

    Do you want to remove this version name and description?

    Transfer ownership

    Transfer to
      Warning: is a public team. If you transfer note to this team, everyone on the web can find and read this note.

        Link with GitHub

        Please authorize HackMD on GitHub
        • Please sign in to GitHub and install the HackMD app on your GitHub repo.
        • HackMD links with GitHub through a GitHub App. You can choose which repo to install our App.
        Learn more  Sign in to GitHub

        Push the note to GitHub Push to GitHub Pull a file from GitHub

          Authorize again
         

        Choose which file to push to

        Select repo
        Refresh Authorize more repos
        Select branch
        Select file
        Select branch
        Choose version(s) to push
        • Save a new version and push
        • Choose from existing versions
        Include title and tags
        Available push count

        Pull from GitHub

         
        File from GitHub
        File from HackMD

        GitHub Link Settings

        File linked

        Linked by
        File path
        Last synced branch
        Available push count

        Danger Zone

        Unlink
        You will no longer receive notification when GitHub file changes after unlink.

        Syncing

        Push failed

        Push successfully