neon

Connecting R and Neon with ADBC

Instructions

Tip

If you already have a Neon instance running, skip the steps to set up and clean up Neon.

Prerequisites

1. Install R

2. Install dbc

3. Install R packages adbcdrivermanager, arrow, and tibble:

   install.packages(c("adbcdrivermanager", "arrow", "tibble"))

Set up Neon

1. Install Docker

2. Install git

3. Clone the Neon repository:

   git clone https://github.com/neondatabase/neon.git

4. Start a Neon instance:

   docker compose --project-directory neon/docker-compose -p neon up -d

Connect to Neon

1. Install the PostgreSQL ADBC driver:

   dbc install postgresql

2. Customize the R script main.R as needed

   • Change the connection arguments in adbc_database_init()
     • Format uri according to the connection URI format used by PostgreSQL, or keep it as is. For cloud-hosted Neon, the connection string can be found at Project dashboard > Connect > Connection string
   • If you changed which database you're connecting to, also change the SQL SELECT statement in read_adbc()

3. Run the R script:

   Rscript main.R

Clean up

1. Stop the Docker project running Neon:

   docker compose -p neon down

2. Remove the Neon repository:

   rm -rf neon