Merge pull request #18 from rustprooflabs/dev

Rewrite to pgx

.cargo/config

@@ -0,0 +1,16 @@
+# Auto-generated by pgx. You may edit this, or delete it to have a new one created.
+
+[target.x86_64-unknown-linux-gnu]
+linker = "./.cargo/pgx-linker-script.sh"
+
+[target.aarch64-unknown-linux-gnu]
+linker = "./.cargo/pgx-linker-script.sh"
+
+[target.x86_64-apple-darwin]
+linker = "./.cargo/pgx-linker-script.sh"
+
+[target.aarch64-apple-darwin]
+linker = "./.cargo/pgx-linker-script.sh"
+
+[target.x86_64-unknown-freebsd]
+linker = "./.cargo/pgx-linker-script.sh"

.cargo/linker-script.sh

@@ -0,0 +1,8 @@
+#! /usr/bin/env bash
+# Auto-generated by pgx. You may edit this, or delete it to have a new one created.
+
+if [[ $CARGO_BIN_NAME == "sql-generator" ]]; then
+    gcc -Wl,-undefined,dynamic_lookup,-dynamic-list=$CARGO_MANIFEST_DIR/.cargo/pgx-dynamic-list.txt $@
+else 
+    gcc -Wl,-undefined,dynamic_lookup $@
+fi

.cargo/pgx-dynamic-list.txt

@@ -0,0 +1 @@
+{ __pgx_internals_*; };

.cargo/pgx-linker-script.sh

@@ -0,0 +1,19 @@
+#! /usr/bin/env bash
+# Auto-generated by pgx. You may edit this, or delete it to have a new one created.
+
+if [[ $CARGO_BIN_NAME == "sql-generator" ]]; then
+    UNAME=$(uname)
+    if [[ $UNAME == "Darwin" ]]; then
+        TEMP=$(mktemp pgx-XXX)
+        echo "*_pgx_internals_*" > ${TEMP}
+        gcc -exported_symbols_list ${TEMP} $@
+        rm -rf ${TEMP}
+    else
+        TEMP=$(mktemp pgx-XXX)
+        echo "{ __pgx_internals_*; };" > ${TEMP}
+        gcc -Wl,-dynamic-list=${TEMP} $@
+        rm -rf ${TEMP}
+    fi
+else
+    gcc -Wl,-undefined,dynamic_lookup $@
+fi

.gitignore

@@ -0,0 +1,7 @@
+/target
+*.iml
+**/*.rs.bk
+Cargo.lock
+sql/*.generated.sql
+extension.dot
+extension.jpg

ADVANCED-INSTALL.md

@@ -0,0 +1,218 @@
+# PgDD Advanced installation
+
+This page covers installing PgDD from source locally, and the Docker build
+method based on [ZomboDB's build system](https://github.com/zombodb/zombodb)
+used to create the binaries.
+
+
+## Install `pgdd` from source
+
+
+One way to install `pgdd` is to install from source by cloning this repository.
+
+### Prereqs
+
+Pgx and its dependencies are the main prereq for PgDD.
+Install Prereqs and ensure PostgreSQL dev tools are installed.
+
+> See the [Cargo PGX](https://github.com/zombodb/pgx/tree/master/cargo-pgx)
+documentation for more information on using pgx.
+
+
+```bash
+sudo apt install postgresql-server-dev-all libreadline-dev zlib1g-dev curl \
+    libssl-dev llvm-dev libclang-dev clang \
+    graphviz
+```
+
+[Install Rust](https://www.rust-lang.org/tools/install) and Pgx.
+
+```bash
+curl https://sh.rustup.rs -sSf | sh -s -- -y
+source $HOME/.cargo/env
+```
+
+Install `cargo-pgx` regularly (see dev steps below for non-standard install).
+
+
+```bash
+cargo install cargo-pgx
+```
+
+
+Install `cargo-deb` used for packaging binaries.
+
+```bash
+cargo install cargo-deb
+```
+
+
+Initialize pgx.  Need to run this after install AND occasionally to get updates
+to Postgres versions or glibc updates.  Not typically required to follow pgx
+developments.
+
+
+```bash
+cargo pgx init
+```
+
+
+### Clone PgDD repo
+
+```bash
+mkdir ~/git
+cd ~/git
+git clone https://github.com/rustprooflabs/pgdd.git
+cd ~/git/pgdd
+```
+
+### Test deployment
+
+Specify version, `pg10` through `pg13` are currently supported. This command will
+start a test instance of Postgres on port `28812`.  Using a different version
+changes the last two digits of the port!
+
+
+```bash
+cargo pgx run pg13
+```
+
+Example output.
+
+```bash
+    Stopping Postgres v13
+building extension with features `pg13`
+"cargo" "build" "--features" "pg13" "--no-default-features"
+    Finished dev [unoptimized + debuginfo] target(s) in 0.05s
+
+installing extension
+     Copying control file to `/home/username/.pgx/13.4/pgx-install/share/postgresql/extension/pgdd.control`
+     Copying shared library to `/home/username/.pgx/13.4/pgx-install/lib/postgresql/pgdd.so`
+    Building SQL generator with features `pg13`
+"cargo" "build" "--bin" "sql-generator" "--features" "pg13" "--no-default-features"
+    Finished dev [unoptimized + debuginfo] target(s) in 0.05s
+ Discovering SQL entities
+  Discovered 9 SQL entities: 0 schemas (0 unique), 6 functions, 0 types, 0 enums, 3 sqls, 0 ords, 0 hashes
+running SQL generator with features `pg13`
+"cargo" "run" "--bin" "sql-generator" "--features" "pg13" "--no-default-features" "--" "--sql" "/home/username/.pgx/13.4/pgx-install/share/postgresql/extension/pgdd--0.4.0-dev.sql"
+    Finished dev [unoptimized + debuginfo] target(s) in 0.06s
+     Running `target/debug/sql-generator --sql /home/username/.pgx/13.4/pgx-install/share/postgresql/extension/pgdd--0.4.0-dev.sql`
+     Copying extension schema file to `/home/username/.pgx/13.4/pgx-install/share/postgresql/extension/pgdd--0.3.1--0.4.0-dev.sql`
+     Copying extension schema file to `/home/username/.pgx/13.4/pgx-install/share/postgresql/extension/pgdd--0.3--0.3.1.sql`
+    Finished installing pgdd
+    Starting Postgres v13 on port 28813
+    Re-using existing database pgdd
+```
+
+In the test instance of psql, create the extension in database.
+
+```bash
+CREATE EXTENSION pgdd;
+```
+
+
+## Build binary packages
+
+Debian/Ubuntu Bionic binaries are available for 0.4.0
+(first [pgx](https://github.com/zombodb/pgx) version)
+and later.  More distributions will likely have binaries available in the future.
+
+
+```bash
+cd build/
+time bash ./build.sh
+```
+
+Tagged versions will be attached to their [releases](https://github.com/rustprooflabs/pgdd/releases).
+
+During development some versions may be copied to the `./standalone/` directory.
+
+```bash
+cp ./target/artifacts/* ./standalone/
+```
+
+## Pgx Generate graphviz
+
+```bash
+cargo pgx schema -d
+dot -Goverlap=prism -Gspline=ortho -Tjpg extension.dot > extension.jpg
+```
+
+![pgx dependencies for pgdd v0.4.0-dev](pgdd--0.4.0-dev.jpg)
+
+
+## Non-standard dev
+
+When working against Pgx installed from a non-tagged branch, install pgx using:
+
+```bash
+cargo install --force --git "https://github.com/zombodb/pgx" \
+    --branch "develop" \
+    "cargo-pgx"
+```
+
+Changes to `Cargo.toml` required in `[lib]` and `[dependencies]` sections.
+
+
+```toml
+[lib]
+# rlib added to build against repo instead of crate (I think)
+crate-type = ["cdylib", "rlib"]
+#crate-type = ["cdylib"]
+```
+
+
+```toml
+[dependencies]
+
+pgx = { git = "https://github.com/zombodb/pgx", branch = "oh-no-type-resolution" }
+pgx-macros = { git = "https://github.com/zombodb/pgx", branch = "develop" }
+#pgx = "0.1.21"
+#pgx-macros = "0.1.21"
+
+# Won't be needed in final version (hopefully!)
+pgx-utils = { git = "https://github.com/zombodb/pgx", branch = "develop" }
+
+[dev-dependencies]
+pgx-tests = { git = "https://github.com/zombodb/pgx", branch = "develop" }
+#pgx-tests = "0.1.21"
+```
+
+
+
+The following command can be used to force pgx to overwrite the configs it needs to
+for various dev related changes.
+
+
+```bash
+cargo pgx schema -f
+```
+
+Another option to try.
+
+```bash
+cargo clean
+```
+
+
+## Non-standard In Docker
+
+If testing this extension against non-standard pgx install, update the
+Dockerfile to install from the specific branch.
+
+Change
+
+```bash
+RUN /bin/bash rustup.sh -y \
+    && cargo install cargo-pgx
+```
+
+To
+
+```bash
+RUN /bin/bash rustup.sh -y \
+    && cargo install --force --git "https://github.com/zombodb/pgx" \
+        --branch "develop" \
+        "cargo-pgx"
+```
+

Cargo.toml

@@ -0,0 +1,45 @@
+[package]
+name = "pgdd"
+version = "0.4.0-dev"
+edition = "2018"
+description = "In-database (PostgreSQL) data dictionary providing database introspection via standard SQL query syntax."
+
+[lib]
+# rlib added to build against repo instead of crate (I think)
+crate-type = ["cdylib", "rlib"]
+#crate-type = ["cdylib"]
+
+[features]
+default = ["pg13"]
+pg10 = ["pgx/pg10"]
+pg11 = ["pgx/pg11"]
+pg12 = ["pgx/pg12"]
+pg13 = ["pgx/pg13"]
+pg_test = []
+
+[dependencies]
+
+pgx = { git = "https://github.com/zombodb/pgx", branch = "develop" }
+pgx-macros = { git = "https://github.com/zombodb/pgx", branch = "develop" }
+#pgx = "0.2.0-beta.1"
+#pgx-macros = "0.2.0-beta.1"
+
+# Won't be needed in final version (hopefully!)
+pgx-utils = { git = "https://github.com/zombodb/pgx", branch = "develop" }
+#pgx-utils = "0.2.0-beta.1"
+
+[dev-dependencies]
+pgx-tests = { git = "https://github.com/zombodb/pgx", branch = "develop" }
+#pgx-tests = "0.2.0-beta.1"
+
+
+[profile.dev]
+panic = "unwind"
+lto = "thin"
+
+[profile.release]
+panic = "unwind"
+opt-level = 3
+lto = "thin"
+codegen-units = 1
+