Skip to content

Latest commit

 

History

History
64 lines (53 loc) · 3.81 KB

README.md

File metadata and controls

64 lines (53 loc) · 3.81 KB

Bayandin's Homebrew Tap

A Homebrew tap with miscellaneous formulae, most notable is neon-local that allows to run Neon locally.

Quick Start

brew install bayandin/tap/neon-local

The command installs neon-local and creates configuration in "$(brew --prefix)/var/neon" directory.

Based on examples from neondatabase/neon repository (instead of cargo neon from the documentation, we use neon-local).

neon-local start
neon-local tenant create --set-default # use `--pg-version \d+` for a particular Postgres version
neon-local tenant list
neon_local endpoint create main  # use `--pg-version \d+` for a particular Postgres version, should match Postgres version for the tenant
neon-local endpoint start main
neon-local endpoint list
neon-local timeline branch --branch-name test
neon-local timeline list
neon_local endpoint create test --branch-name test
neon-local endpoint start test
psql -p 55432 -h 127.0.0.1 -U cloud_admin postgres

Formulae in the tap

  • neon-local. Meta-formula that installs all the required dependencies and configures Neon to run locally.
    • neon-storage. Storage part of Neon. It contains Pageserver, Safekeeper, and other required binaries
    • neon-postgres. Compute part of Neon. The formula contains all supported by Neon Postgres versions
    • neon-extension. Postgres extensions that provide communication between Compute and Storage
  • neon-proxy. Proxy for Neon
  • curl-without-ipv6. Curl formula without IPv6 support
  • teleport@16 — Modern SSH server for teams managing distributed infrastructure. Version 16
  • tpc-h. TPC-H benchmark with patches for MacOS and Postgres support

Extensions:

In addition, you can try Neon locally with extensions from this tap. To install them run the following command brew install bayandin/tap/<extension>:

  • h3-pg — PostgreSQL bindings for H3, a hierarchical hexagonal geospatial indexing system
  • hypopg — Hypothetical Indexes for PostgreSQL
  • ip4r — IPv4/v6 and IPv4/v6 range index type for PostgreSQL
  • pg_cron — Run periodic jobs in PostgreSQL
  • pg_graphql — GraphQL support for PostgreSQL
  • pg_hashids — Short unique id generator for PostgreSQL, using hashids
  • pg_jsonschema — PostgreSQL extension providing JSON Schema validation
  • pg_tiktoken — Tiktoken tokenizer for PostgreSQL
  • pgjwt — PostgreSQL implementation of JWT (JSON Web Tokens)
  • pgtap — PostgreSQL Unit Testing Suite
  • pgvector — Open-source vector similarity search for Postgres
  • plpgsql_check — Plpgsql linter
  • plv8 — V8 Engine Javascript Procedural Language add-on for PostgreSQL
  • postgresql-hll — PostgreSQL extension adding HyperLogLog data structures as a native data type
  • postgresql-unit — SI Units for PostgreSQL
  • prefix — Prefix Range module for PostgreSQL
  • rum — Inverted index with additional information in posting lists
  • timescaledb — Open-source time-series SQL database optimized for fast ingest and complex queries

Note: extensions provided by the tap could be different from what's available in Neon Cloud offering.