ivorysql compatible with documentdb

Author: balinorLiang

.devcontainer/Dockerfile

@@ -1,10 +1,10 @@
 FROM mcr.microsoft.com/mirror/docker/library/ubuntu:22.04
 ARG POSTGRES_INSTALL_ARG=
-ARG PG_VERSION=16
+ARG IVORY_VERSION=4
 ARG CITUS_VERSION=12
 
 # declare installed PG version and Citus version
-ENV PG_VERSION=${PG_VERSION}
+ENV IVORY_VERSION=${IVORY_VERSION}
 ENV CITUS_VERSION=${CITUS_VERSION}
 
 # Install build essentials - Compiler, debugger, make, etc.
@@ -35,6 +35,7 @@ RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
     libtool \
     libicu-dev \
     libssl-dev \
+    libxml2-dev \
     && rm -rf /var/lib/apt/lists/*
 
 # Add pgdg repo
@@ -60,27 +61,27 @@ COPY scripts/utils.sh /tmp/install_setup/
 
 # Install postgres
 COPY scripts/install_setup_postgres.sh /tmp/install_setup/
-RUN [ "bin/bash", "-c", "/tmp/install_setup/install_setup_postgres.sh -d \"/usr/lib/postgresql/${PG_VERSION}\" $POSTGRES_INSTALL_ARG -v ${PG_VERSION}" ]
+RUN [ "bin/bash", "-c", "/tmp/install_setup/install_setup_postgres.sh -d \"/var/local/ivorysql/ivory-${IVORY_VERSION}\" $POSTGRES_INSTALL_ARG -v ${IVORY_VERSION}" ]
 
 # Install RUM from source
 COPY scripts/install_setup_rum_oss.sh /tmp/install_setup/
-RUN [ "bin/bash", "-c", "PGVERSION=$PG_VERSION /tmp/install_setup/install_setup_rum_oss.sh" ]
+RUN [ "bin/bash", "-c", "IVORYVERSION=$IVORY_VERSION /tmp/install_setup/install_setup_rum_oss.sh" ]
 
 # Install citus
 COPY scripts/install_setup_citus_core_oss.sh /tmp/install_setup/
-RUN [ "bin/bash", "-c", "PGVERSION=$PG_VERSION /tmp/install_setup/install_setup_citus_core_oss.sh ${CITUS_VERSION}" ]
+RUN [ "bin/bash", "-c", "IVORYVERSION=$IVORY_VERSION /tmp/install_setup/install_setup_citus_core_oss.sh ${CITUS_VERSION}" ]
 
 # Install citus-indent
 COPY scripts/install_citus_indent.sh /tmp/install_setup/
 RUN [ "bin/bash", "-c", "/tmp/install_setup/install_citus_indent.sh" ]
 
 # Install SYSTEM_ROWS
 COPY scripts/install_setup_system_rows.sh /tmp/install_setup/
-RUN [ "bin/bash", "-c", "PGVERSION=$PG_VERSION /tmp/install_setup/install_setup_system_rows.sh" ]
+RUN [ "bin/bash", "-c", "IVORYVERSION=$IVORY_VERSION /tmp/install_setup/install_setup_system_rows.sh" ]
 
 # Install PG_CRON
 COPY scripts/install_setup_pg_cron.sh /tmp/install_setup/
-RUN [ "bin/bash", "-c", "PGVERSION=$PG_VERSION /tmp/install_setup/install_setup_pg_cron.sh" ]
+RUN [ "bin/bash", "-c", "IVORYVERSION=$IVORY_VERSION /tmp/install_setup/install_setup_pg_cron.sh" ]
 
 # Download Decimal128 Intel library
 COPY scripts/install_setup_intel_decimal_math_lib.sh /tmp/install_setup/
@@ -92,7 +93,7 @@ RUN [ "bin/bash", "-c", "/tmp/install_setup/install_setup_pcre2.sh" ]
 
 # Install PG_VECTOR
 COPY scripts/install_setup_pgvector.sh /tmp/install_setup/
-RUN [ "bin/bash", "-c", "PGVERSION=$PG_VERSION /tmp/install_setup/install_setup_pgvector.sh" ]
+RUN [ "bin/bash", "-c", "IVORYVERSION=$IVORY_VERSION /tmp/install_setup/install_setup_pgvector.sh" ]
 
 # Install PostGIS from source
 RUN apt-get update && \
@@ -105,7 +106,7 @@ RUN apt-get update && \
     && rm -rf /var/lib/apt/lists/*
 
 COPY scripts/install_setup_postgis.sh /tmp/install_setup/
-RUN [ "bin/bash", "-c", "PGVERSION=$PG_VERSION /tmp/install_setup/install_setup_postgis.sh" ]
+RUN [ "bin/bash", "-c", "IVORYVERSION=$IVORY_VERSION /tmp/install_setup/install_setup_postgis.sh" ]
 
 # locale
 RUN rm -rf /var/lib/apt/lists/* \
@@ -121,10 +122,10 @@ RUN echo "%sudo ALL=(ALL:ALL) NOPASSWD: ALL" >> /etc/sudoers.d/no-pass-ask
 
 # Add postgres to path for sudo commands.
 # Add path for sudoers
-RUN cat /etc/sudoers | grep secure_path | sed "s/\:\/bin\:/\:\/bin\:\/usr\/lib\/postgresql\/$PG_VERSION\/bin\:/" >> /etc/sudoers.d/postgres_path
+RUN cat /etc/sudoers | grep secure_path | sed "s/\:\/bin\:/\:\/bin\:\/var\/local\/ivorysql\/ivory-$IVORY_VERSION\/bin\:/" >> /etc/sudoers.d/postgres_path
 
 # Add PG to the path
-ENV PATH=$PATH:/usr/lib/postgresql/$PG_VERSION/bin
+ENV PATH=$PATH:/var/local/ivorysql/ivory-$IVORY_VERSION/bin
 
 USER documentdb
 WORKDIR /home/documentdb

README.md

@@ -1,6 +1,8 @@
 # Introduction
 
-`DocumentDB` is the engine powering vCore-based Azure Cosmos DB for MongoDB. It offers a native implementation of document-oriented NoSQL database, enabling seamless CRUD operations on BSON data types within a PostgreSQL framework. Beyond basic operations, DocumentDB empowers you to execute complex workloads, including full-text searches, geospatial queries, and vector embeddings on your dataset, delivering robust functionality and flexibility for diverse data management needs.
+`ivydocumentdb` is an open-source project developed based on Microsoft DocumentDB and compatible with IvorySQL. It offers a native implementation of document-oriented NoSQL database, enabling seamless CRUD (Create, Read, Update, Delete) operations on BSON(Binary JSON) data types within an IvorySQL framework. Beyond basic operations, ivydocumentdb empowers you to execute complex workloads, including full-text searches, geospatial queries, and vector embeddings on your dataset, delivering robust functionality and flexibility for diverse data management needs.
+
+[IvorySQL](https://docs.ivorysql.org/en/ivorysql-doc) is advanced, fully featured, open source Oracle compatible PostgreSQL with a firm commitment to always remain 100% compatible and a Drop-in replacement of the latest PostgreSQL.
 
 [PostgreSQL](https://www.postgresql.org/about/) is a powerful, open source object-relational database system that uses and extends the SQL language combined with many features that safely store and scale the most complicated data workloads.
 
@@ -38,24 +40,24 @@ By building on PostgreSQL, DocumentDB leverages these strengths to provide a pow
 
 ### Building DocumentDB with Docker
 
-Step 1: Clone the DocumentDB repo.
+Step 1: Clone the ivydocumentdb repo.
 
 ```bash
-git clone https://github.com/microsoft/documentdb.git
+git clone https://github.com/ivorysql/ivydocumentdb.git
 ```
 
 Step 2: Create the docker image. Navigate to cloned repo.
 
 ```bash
-docker build . -f .devcontainer/Dockerfile -t documentdb 
+docker build . -f .devcontainer/Dockerfile -t ivydocumentdb 
 ```
 
 Note: Validate using `docker image ls`
 
 Step 3: Run the Image as a container
 
 ```bash
-docker run -v $(pwd):/home/documentdb/code -it documentdb /bin/bash 
+docker run -v $(pwd):/home/documentdb/code -it ivydocumentdb /bin/bash 
 
 cd code
 ```
@@ -79,36 +81,6 @@ Note: To run backend postgresql tests after installing you can run `make check`.
 
 You are all set to work with DocumentDB.
 
-### Using the Prebuilt Docker Image
-
-You can use a [prebuilt docker image](https://github.com/microsoft/documentdb/pkgs/container/documentdb%2Fdocumentdb-oss/versions?filters%5Bversion_type%5D=tagged) for DocumentDB instead of building it from source.  Follow these steps:
-
-#### Pull the Prebuilt Image
-
-Pull the prebuilt image directly from the Microsoft Container Registry:
-
-```bash
-docker pull ghcr.io/microsoft/documentdb/documentdb-oss:PG16-amd64-0.105.0
-```
-
-#### Running the Prebuilt Image
-
-To run the prebuilt image, use one of the following commands:
-
-1. Run the container:
-
-```bash
-docker run -dt ghcr.io/microsoft/documentdb/documentdb-oss:PG16-amd64-0.105.0
-```
-
-2. If external access is required, run the container with parameter "-e":
-
-```bash
-docker run -p 127.0.0.1:9712:9712 -dt ghcr.io/microsoft/documentdb/documentdb-oss:PG16-amd64-0.105.0 -e
-```
-
-This will start the container and map port `9712` from the container to the host.
-
 ### Connecting to the Server
 #### Internal Access
 Step 1: Run `start_oss_server.sh` to initialize the DocumentDB server and manage dependencies.
@@ -297,16 +269,3 @@ The example presents each patient along with the doctors visited.
 ```sql
 SELECT cursorpage FROM documentdb_api.aggregate_cursor_first_page('documentdb', '{ "aggregate": "patient", "pipeline": [ { "$lookup": { "from": "appointment","localField": "patient_id", "foreignField": "patient_id", "as": "appointment" } },{"$unwind":"$appointment"},{"$project":{"_id":0,"name":1,"appointment.doctor_name":1,"appointment.appointment_date":1}} ], "cursor": { "batchSize": 3 } }');
 ```
-
-### Community
-
-- Please refer to page for contributing to our [Roadmap list](https://github.com/orgs/microsoft/projects/1407/views/1).
-- [FerretDB](https://github.com/FerretDB/FerretDB) integration allows using DocumentDB as backend engine.
-
-Contributors and users can join the [DocumentDB Discord channel in the Microsoft OSS server](https://aka.ms/documentdb_discord) for quick collaboration.
-
-### FAQs
-
-Q1. While performing `make check` if you encounter error `FATAL:  "/home/documentdb/code/pg_documentdb_core/src/test/regress/tmp/data" has wrong ownership`?
-
-Please drop the `/home/documentdb/code/pg_documentdb_core/src/test/regress/tmp/` directory and rerun the `make check`.

scripts/build_and_start_gateway.sh

@@ -84,21 +84,21 @@ while [[ -L $source ]]; do
 done
 scriptDir="$(cd -P "$(dirname "$source")" && pwd)"
 
-# Check if PostgreSQL is running with a timeout of 10 minutes
+# Check if IvorySQL is running with a timeout of 10 minutes
 timeout=600
 interval=5
 elapsed=0
 
-echo "Waiting for PostgreSQL to be ready on $hostname:$port..."
+echo "Waiting for IvorySQL to be ready on $hostname:$port..."
 while ! pg_isready -h "$hostname" -p "$port" > /dev/null 2>&1; do
     if [ "$elapsed" -ge "$timeout" ]; then
-        echo "PostgreSQL did not become ready within 10 minutes. Exiting."
+        echo "IvorySQL did not become ready within 10 minutes. Exiting."
         exit 1
     fi
     sleep "$interval"
     elapsed=$((elapsed + interval))
 done
-echo "PostgreSQL is ready."
+echo "IvorySQL is ready."
 
 if [ "$clean" = "true" ]; then
     echo "Cleaning the build directory..."

scripts/generate_extension_version.sh

@@ -33,7 +33,7 @@ if [ -f $gitIndexDir ]; then
     else
         # set GIT_VERSION with current branch's name and the short sha of the HEAD
         GIT_VERSION=$(git rev-parse --abbrev-ref HEAD)
-        GIT_SHA=$(git rev-parse --short HEAD)
+        GIT_SHA=$(git rev-parse --short=10 HEAD)
     fi
 
     if [[ "$GIT_VERSION" == "" ]] || [[ "$GIT_SHA" == "" ]]; then

scripts/install_setup_citus_core_oss.sh

@@ -22,8 +22,8 @@ scriptDir="$( cd -P "$( dirname "$source" )" && pwd )"
 CITUS_REF=$(GetCitusVersion $citusVersion)
 
 . $scriptDir/utils.sh
-if [ "${PGVERSION:-}" != "" ]; then
-    pgPath=$(GetPostgresPath $PGVERSION)
+if [ "${IVORYVERSION:-}" != "" ]; then
+    pgPath=$(GetPostgresPath $IVORYVERSION)
     PATH=$pgPath:$PATH
 fi
 

scripts/install_setup_pg_cron.sh

@@ -20,7 +20,7 @@ scriptDir="$( cd -P "$( dirname "$source" )" && pwd )"
 CITUS_PG_CRON_REF=$(GetPgCronVersion)
 
 . $scriptDir/utils.sh
-pgBinDir=$(GetPostgresPath $PGVERSION)
+pgBinDir=$(GetPostgresPath $IVORYVERSION)
 PATH=$pgBinDir:$PATH;
 
 pushd $INSTALL_DEPENDENCIES_ROOT

scripts/install_setup_pgvector.sh

@@ -18,7 +18,7 @@ scriptDir="$( cd -P "$( dirname "$source" )" && pwd )"
 echo "scriptDir: $scriptDir"
 
 . $scriptDir/utils.sh
-pgBinDir=$(GetPostgresPath $PGVERSION)
+pgBinDir=$(GetPostgresPath $IVORYVERSION)
 PATH=$pgBinDir:$PATH;
 
 . $scriptDir/setup_versions.sh

scripts/install_setup_postgis.sh

@@ -27,7 +27,7 @@ scriptDir="$( cd -P "$( dirname "$source" )" && pwd )"
 POSTGIS_REF=$(GetPostgisVersion)
 
 . $scriptDir/utils.sh
-pgBinDir=$(GetPostgresPath $PGVERSION)
+pgBinDir=$(GetPostgresPath $IVORYVERSION)
 
 POSTGIS_REPO=postgis-repo
 rm -rf $POSTGIS_REPO

scripts/install_setup_postgres.sh

@@ -5,22 +5,22 @@ set -e
 # fail if trying to reference a variable that is not set.
 set -u
 
-postgresqlInstallDir=""
+ivorysqlInstallDir=""
 debug="false"
 cassert="false"
 help="false";
-pgVersion=""
+ivyVersion=""
 while getopts "d:hxcv:" opt; do
   case $opt in
-    d) postgresqlInstallDir="$OPTARG"
+    d) ivorysqlInstallDir="$OPTARG"
     ;;
     x) debug="true"
     ;;
     c) cassert="true"
     ;;
     h) help="true"
     ;;
-    v) pgVersion="$OPTARG"
+    v) ivyVersion="$OPTARG"
     ;;
   esac
 
@@ -34,18 +34,18 @@ while getopts "d:hxcv:" opt; do
 done
 
 if [ "$help" == "true" ]; then
-    echo "downloads postgresql-14.2 sources, build and install it."
-    echo "[-d] the directory to install postgresql to. Default: /usr/lib/postgresql/14"
+    echo "downloads IvorySQL-14.2 sources, build and install it."
+    echo "[-d] the directory to install IvorySQL to. Default: /usr/lib/IvorySQL/14"
     echo "[-x] build with debug symbols."
     exit 1;
 fi
 
-if [ -z $postgresqlInstallDir ]; then
+if [ -z $ivorysqlInstallDir ]; then
     echo "Postgres Install Directory must be specified."
     exit 1;
 fi
 
-if [ -z $pgVersion ]; then
+if [ -z $ivyVersion ]; then
   echo "PG Version must be specified";
   exit 1;
 fi
@@ -62,29 +62,29 @@ done
 scriptDir="$( cd -P "$( dirname "$source" )" && pwd )"
 
 . $scriptDir/setup_versions.sh
-POSTGRESQL_REF=$(GetPostgresSourceRef $pgVersion)
+IvorySQL_REF=$(GetPostgresSourceRef $ivyVersion)
 
 pushd $INSTALL_DEPENDENCIES_ROOT
 
-rm -rf postgres-repo/$pgVersion
-mkdir -p postgres-repo/$pgVersion
-cd postgres-repo/$pgVersion
+rm -rf postgres-repo/$ivyVersion
+mkdir -p postgres-repo/$ivyVersion
+cd postgres-repo/$ivyVersion
 
 git init
-git remote add origin https://github.com/postgres/postgres
+git remote add origin https://github.com/IvorySQL/IvorySQL
 
 # checkout to the commit specified in the cgmanifest.json
-git fetch --depth 1 origin "$POSTGRESQL_REF"
+git fetch --depth 1 origin "$IvorySQL_REF"
 git checkout FETCH_HEAD
 
-echo "building and installing postgresql ref $POSTGRESQL_REF and installing to $postgresqlInstallDir..."
+echo "building and installing IvorySQL ref $IvorySQL_REF and installing to $ivorysqlInstallDir..."
 
 if [ "$debug" == "true" ]; then
-  ./configure --enable-debug --enable-cassert --enable-tap-tests CFLAGS="-ggdb -Og -g3 -fno-omit-frame-pointer" --with-openssl --prefix="$postgresqlInstallDir" --with-icu
+  ./configure --enable-debug --enable-cassert --enable-tap-tests CFLAGS="-ggdb -Og -g3 -fno-omit-frame-pointer" --with-openssl --prefix="$ivorysqlInstallDir" --with-icu
 elif [ "$cassert" == "true" ]; then
-  ./configure --enable-debug --enable-cassert --enable-tap-tests --with-openssl --prefix="$postgresqlInstallDir" --with-icu
+  ./configure --enable-debug --enable-cassert --enable-tap-tests --with-openssl --prefix="$ivorysqlInstallDir" --with-icu
 else
-  ./configure --enable-debug --enable-tap-tests --with-openssl --prefix="$postgresqlInstallDir" --with-icu
+  ./configure --enable-debug --enable-tap-tests --with-openssl --prefix="$ivorysqlInstallDir" --with-icu
 fi
 
 make clean && make -sj$(cat /proc/cpuinfo | grep -c "processor") install

scripts/install_setup_rum_oss.sh

@@ -21,8 +21,8 @@ echo "scriptDir: $scriptDir"
 RUM_REF=$(GetRumVersion)
 
 . $scriptDir/utils.sh
-if [ "${PGVERSION:-}" != "" ]; then
-    pgPath=$(GetPostgresPath $PGVERSION)
+if [ "${IVORYVERSION:-}" != "" ]; then
+    pgPath=$(GetPostgresPath $IVORYVERSION)
     PATH=$pgPath:$PATH
 fi