diff --git a/CODEOWNERS b/CODEOWNERS index 646fa26..500e441 100644 --- a/CODEOWNERS +++ b/CODEOWNERS @@ -7,4 +7,4 @@ # Top level # TODO: Update with new owners of files added -/* @mandy-chessell @planetf1 +/* @mandy-chessell @dwolfson diff --git a/README.md b/README.md index d391d4b..c0f837c 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,77 @@ - - +# Overview +This directory contains sample Docker Compose scripts to support the deployment of Egeria for experimentation, +development, and learning. Rather than having to install Egeria, prerequisites and tools separately, these scripts make +it easy to get a stack running quickly. +These are not meant for production use. Please see the [Planning Guide](https://egeria-project.org/guides/planning/) +for more information about designing Egeria deployments. The Egeria community has also created samples for other +deployment styles, such as Cloud Native approaches and the use of Helm charts to configure Kubernetes clusters. These +options may be better starting points for production deployments - depending upon your requirements. +Please feel free to engage with the community on our slack channel - we'd love your feedback and participation. -# Egeria - +For a quick and simple environment to explore some of Egeria's base capabilities, the **egeria-platform.yml** Docker Compose +deployment may be a good starting point. Once this script executes successfully, you will have two docker containers running. One for the Egeria platform and one for Kafka. With this running configuration, you can work with any of Egeria's standard interfaces - java APIs, python APIs, or just plain RESTful http calls - and of course, to make use of tools and interfaces that have been built using these APIs. -See https://egeria-project.org for the main Egeria Documentation. +The set of **Docker Compose** configurations will grow and evolve over time to cover additional scenarios. -This is a new repository that we are currently setting up. +# Contents -A description and more content should be added here soon. +Our first docker compose script is called **egeria-platform.yml**. After running this script, you will have a running environment +that consists of a single Egeria runtime platform and the Apache Kafka event system. Information about configuring +Egeria can be found at [Configuring Egeria](https://egeria-project.org/guides/admin/configuring-the-omag-server-platform/). +We use standard, out-of-the-box configurations for both - a minimal amount of configuration for: + +## Egeria Platform - Default Configuration +We use the Egeria platform docker image - [egeria-platform](https://hub.docker.com/r/odpi/egeria-platform). + +* Port - By default the platform uses port 9443 and exposes this port to the host environment, This means that Egeria requests +can be made to platform URL **https://localhost:9443** or, if your environment is configured to support it, it can use +the domain name of your host machine. +* SSL - By default strict SSL is set to false +* Auto-Started Servers - by default a useful set of Egeria Open Metadata and Governance (OMAG) servers are pre-installed +and started when the Egeria platform is started. A description of these servers can be found at [sample configs](https://github.com/odpi/egeria/tree/main/open-metadata-resources/open-metadata-deployment/sample-configs): + + * simple-metadata-store + * active-metadata-store + * engine-host + * integration-daemon + * view-server + +* Content Packs - pre-constructed information sets that can be used to configure Egeria and pre-load metadata, reference data and glossary data. See [Content Packs](https://egeria-project.org/content-packs/). +* Out-of-the-box Connectors - descriptions of the integration connectors can be found at [Integration Connectors](https://egeria-project.org/connectors/). + +## Kafka - configured for Egeria +We use the bitnami/kafka image described at [kafka](https://hub.docker.com/r/bitnami/kafka) +* Port - We use the default port of 9092 for Kafka. This port is also exposed in the host environment. Changing this port also requires corresponding changes to the Egeria configuration. +* Other configuration can be seen in the *egeria-platform.yaml* file. + +# Usage +Follow these steps to use Docker Compose. + +1. Install and Configure Docker and Docker Compose. + * Docker and Docker compose must be installed and running - see https://docs.docker.com/install/ + * Configure docker with at least 6GB memory +2. Download the [**egeria-platform.yaml**](https://raw.githubusercontent.com/odpi/egeria/main/open-metadata-resources/open-metadata-deployment/docker-compose/egeria-platform-compose/egeria-platform.yaml) +3. Run the docker compose script from a terminal window in the directory where you downloaded `egeria-platform.yaml`. At the command line issue: + + `docker compose -f egeria-platform.yaml up` + +This will download the docker images for Kafka and Egeria, then create and start the two containers. Both kafka and Egeria will then automatically configure themselves. For Egeria, this means not only starting up the initial set of servers, but then loading the **CoreContentPack.omarchive** into the metadata repository, and then configuring all the servers. This can take several minutes the first time the containers are created. Subsequent startups will be much faster. + +4. Using either the **docker desktop** application or the docker command line you can see the two new containers running. To do this with the docker command line, you can issue: + +`docker ps` + +5. The environment is ready to be used. + +6. You can control the containers with docker compose commands - see [docker compose](https://docs.docker.com/reference/cli/docker/compose/). These commands can be used to administer and use the docker containers. + +## Next Steps + +Now that your Egeria environment is running and configured it is waiting for you to make requests. +Some tutorials for working with Egeria can be found at [Tutorials](https://egeria-project.org/education/tutorials/). For those that want to try the new python client, you can find a quick introduction at [pyegeria](https://getting-started-with-egeria.pdr-associates.com/recipe-6-charming-python.html). + +As always, your feedback and participation are welcome. + + +License: CC BY 4.0, Copyright Contributors to the ODPi Egeria project. \ No newline at end of file diff --git a/build.gradle b/build.gradle deleted file mode 100644 index 5624f37..0000000 --- a/build.gradle +++ /dev/null @@ -1,279 +0,0 @@ -/* - * SPDX-License-Identifier: Apache-2.0 - * Copyright Contributors to the ODPi Egeria project. - */ - -plugins { - id 'java-library' - id "com.github.johnrengelman.shadow" version "8.1.0" - id 'idea' - id 'maven-publish' - // Checks for unnecessary dependencies - id 'com.autonomousapps.dependency-analysis' version "1.19.0" - // helps resolve log implementation clashes - id 'dev.jacomet.logging-capabilities' version "0.11.0" - // This plugin helps resolve jakarta/javax dev.jacomet.logging-capabilities - id 'org.gradlex.java-ecosystem-capabilities' version "1.1" - // copyright checks - id 'checkstyle' - -} - -// Mostly java, so default to this for now -apply plugin: 'java' -apply plugin: 'jacoco' -apply plugin: 'org.gradlex.java-ecosystem-capabilities' -apply plugin: 'dev.jacomet.logging-capabilities' -// As we've migrated from maven - we'll assume all submodules publish directly to maven -apply plugin: 'maven-publish' - -if (System.getenv("CI")) { - apply plugin: 'signing' -} - -repositories { - mavenCentral() - maven { url("https://oss.sonatype.org/content/repositories/snapshots") } -} - -// ensures we pick up the very latest snapshots when built -configurations.all { - // check for updates every build - resolutionStrategy.cacheChangingModulesFor 0, 'seconds' -} - -// TODO: Specify group, description, version of new code being built. The name is in settings.gradle -group = 'org.odpi.egeria' -version = '1.0-SNAPSHOT' -description = 'New code for Egeria' - -// TODO: Specify Dependency versions as variables -ext { - egeriaVersion = '4.0-SNAPSHOT' -} - -// For a single module, add here. For multiple modules, refactor and use constraints (see main egeria build.gradle for an example) - - -dependencies { - - // This will set constraints so that dependencies here follow egeria versions - implementation platform("org.odpi.egeria:egeria:${egeriaVersion}") - - // Many of these dependencies are in the platform already - in which case leave version empty - // Only used for build - already present in server chassis at runtime - similar to 'provided' with maven - compileOnly "org.odpi.egeria:audit-log-framework" - - // Needed for build and run - also found in the platform - compileOnly "org.slf4j:slf4j-api" - - // Only needed to compile test code - testImplementation "com.fasterxml.jackson.core:jackson-annotations" - testImplementation "org.junit.jupiter:junit-jupiter-api" - testRuntimeOnly "org.junit.jupiter:junit-jupiter-engine" - -} - - -// Testing -test { - useJUnitPlatform { - includeEngines 'junit-jupiter' - } - testLogging { - events "passed", "skipped", "failed" - } - reports { - html.required = true - } -} - - -// Maven Central (technically sonatype oss) requires we distribute source and javadoc. -java { - sourceCompatibility = JavaVersion.VERSION_17 - targetCompatibility = JavaVersion.VERSION_17 - withJavadocJar() - withSourcesJar() -} - -// More Java language settings -tasks.withType(JavaCompile) { - options.encoding = 'UTF-8' - sourceCompatibility = "17" - targetCompatibility = "17" - options.incremental = true - options.fork = false - options.failOnError = true - options.compilerArgs << '-Xlint:unchecked' << '-Xlint:deprecation' -} - -// For later java versions this is recommended - keep conditional in case we want to build on 8 -javadoc { - if (JavaVersion.current().isJava9Compatible()) { - options.addBooleanOption('html5', true) - } -} - -// code coverage -jacoco { - toolVersion = "0.8.8" -} - -// Can remove the shadowJar definitions if a jar with dependencies is not needed -// compileonly content won't be included, so even an uber jar should not contain egeria dependencies already in chassis. -shadowJar { - archiveClassifier = 'jar-with-dependencies' -} - -// We want to built a jar with dependencies in a normal build, so to avoid specifying task explicitly -build.dependsOn shadowJar - - -// We only have a single artifact for now - this additional metadata is -// required for publishing to maven central. Only doing signing in 'CI' -publishing { - publications { - connector(MavenPublication) { - from components.java - pom { - url = 'http://egeria.odpi.org' - licenses { - // Code - license { - name = 'The Apache License, Version 2.0' - url = 'http://www.apache.org/licenses/LICENSE-2.0.txt' - } - // Docs - license { - name = 'Creative Commons Attribution 4.0 International (CC BY 4.0)' - url = 'https://creativecommons.org/licenses/by/4.0' - } - } - developers { - developer { - id = 'planetf1' - name = 'Nigel Jones' - email = 'nigel.l.jones+git@gmail.com' - } - } - scm { - // TODO: Update references to git source for this particular repository - connection = 'scm:git:git://github.com/odpi/egeria-template-newrepo.git' - developerConnection = 'scm:git:ssh://github.com/odpi/egeria/egeria-template-newrepo.git' - url = 'http://github.com/odpi/egeria-template-newrepo/' - } - } - // The maven artifact name comes from settings.gradle, if not found there defaults to directory name - pom.withXml { - asNode().appendNode('description', "${project.description}") - } - } - } - - // Release versions get pushed to staging area on maven central, snapshots to snapshot repo - // Secrets for credentials - if (System.getenv("CI")) { - repositories { - maven { - name = 'OSSRH' - def releasesRepoUrl = 'https://oss.sonatype.org/service/local/staging/deploy/maven2' - def snapshotsRepoUrl = 'https://oss.sonatype.org/content/repositories/snapshots' - url = version.endsWith('SNAPSHOT') ? snapshotsRepoUrl : releasesRepoUrl - // User token (under profile) on oss.sonatype.org - credentials { - username = System.getenv("OSSRH_USERNAME") - password = System.getenv("OSSRH_TOKEN") - } - } - } - } -} - -// To publish to ossrh we need to sign the artifacts - only in CI -if (System.getenv("CI")) { - signing { - // This is the publication to sign - sign publishing.publications.connector - // gpg --export-secret-keys myemal@gmail.com | base64 - def signingKey = System.getenv("OSSRH_GPG_PRIVATE_KEY") - // Passphrase for key - def signingPassword = System.getenv("OSSRH_GPG_PASSPHRASE") - // public key id (last 8 characters only) - note keys also need uploading to all the main registries - def signingKeyId = System.getenv("OSSRH_GPG_KEYID") - // We use these values from secrets rather than gradle.properties - useInMemoryPgpKeys(signingKeyId, signingKey, signingPassword) - } -} - -/* - * Additional useful tasks - */ -task printAllDependencies(type: DependencyReportTask) {} -task printSubDependencies(type: DependencyReportTask) {} -task findDependency(type: DependencyInsightReportTask) {} - - -/* - * Configuration for sub projects only - */ -subprojects { - // All tasks currently will run under allProjects - which includes root. -} - -/* - * Additional aggregate tasks run only at parent - */ - -// Jacoco reporting -- from gradle docs -task codeCoverageReport(type: JacocoReport) { - // Gather execution data from all subprojects - executionData fileTree(project.rootDir.absolutePath).include("**/build/jacoco/*.exec") - - // Add all relevant sourcesets from the subprojects - subprojects.each { - sourceSets it.sourceSets.main - } - - // enable the different report types (html, xml, csv) - reports { - // xml is usually used to integrate code coverage with - // other tools like SonarQube, Coveralls or Codecov - xml.required = true - - // HTML reports can be used to see code coverage - // without any external tools - html.required = true - csv.required = true - } - -} -// always run the tests before generating the report -codeCoverageReport.dependsOn { - subprojects*.test -} - -// Dependency checking - see https://github.com/autonomousapps/dependency-analysis-android-gradle-plugin -dependencyAnalysis { - issues { - all { - onAny { - severity('fail') - } - onUnusedDependencies { - exclude("junit:junit", "org.junit.jupiter:junit-jupiter-api", "org.junit.jupiter:junit-jupiter-engine", "com.fasterxml.jackson.core:jackson-annotations") - } - } - } -} - -// Checking of javaheaders for license & copyright -checkstyle { - toolVersion = '10.7.0' - showViolations = true -} - -// Always run dependency check for every regular build -build.dependsOn("buildHealth") - - diff --git a/config/checkstyle/checkstyle.xml b/config/checkstyle/checkstyle.xml deleted file mode 100644 index 5b27a02..0000000 --- a/config/checkstyle/checkstyle.xml +++ /dev/null @@ -1,19 +0,0 @@ - - - - - - - - - - - - - - - - - diff --git a/config/checkstyle/java.header b/config/checkstyle/java.header deleted file mode 100644 index 2ce66e0..0000000 --- a/config/checkstyle/java.header +++ /dev/null @@ -1,2 +0,0 @@ - ^/* SPDX-License-Identifier: Apache-2.0 */$ - ^/* Copyright Contributors to the ODPi Egeria project. */$ diff --git a/egeria-platform-compose/README.md b/egeria-platform-compose/README.md new file mode 100644 index 0000000..4750b4f --- /dev/null +++ b/egeria-platform-compose/README.md @@ -0,0 +1,83 @@ +# Overview +This directory contains sample Docker Compose scripts to support the deployment of Egeria for experimentation, +development, and learning. Rather than having to install Egeria, prerequisites and tools separately, these scripts make +it easy to get a stack running quickly. +These are not meant for production use. Please see the [Planning Guide](https://egeria-project.org/guides/planning/) +for more information about designing Egeria deployments. The Egeria community has also created samples for other +deployment styles, such as Cloud Native approaches and the use of Helm charts to configure Kubernetes clusters. These +options may be better starting points for production deployments - depending upon your requirements. +Please feel free to engage with the community on our slack channel - we'd love your feedback and participation. + + +For a quick and simple environment to explore some of Egeria's base capabilities, the **egeria-platform.yml** Docker Compose +deployment may be a good starting point. Once this script executes successfully, you will have two docker containers running. One for the Egeria platform and one for Kafka. With this running configuration, you can work with any of Egeria's standard interfaces - java APIs, python APIs, or just plain RESTful http calls - and of course, to make use of tools and interfaces that have been built using these APIs. + +The set of **Docker Compose** configurations will grow and evolve over time to cover additional scenarios. For example, +the folder `egeria-platform-postgres-compose` contains a docker compose configuration that adds a Postgres +database along with the Egeria OMAG platform and Kafka servers. This sets the stage emerging scenarios that +utilize a relational database to collect Egeria derived information such as Audit logs for additional analysis and dashboarding. +Please see the embedded README.md files for more details. + +# Contents + +* egeria-platform-compose - a basic Egeria OMAG platform standalone deployment that includes Kafka as well as Egeria. +* egeria-platform-postgres-compose - deploys and configures a Postgres relational database as well as Kafka and Egeria. + +Our first docker compose script is called **egeria-platform.yml**. After running this script, you will have a running environment +that consists of a single Egeria runtime platform and the Apache Kafka event system. Information about configuring +Egeria can be found at [Configuring Egeria](https://egeria-project.org/guides/admin/configuring-the-omag-server-platform/). +We use standard, out-of-the-box configurations for both - a minimal amount of configuration for: + +## Egeria Platform - Default Configuration +We use the Egeria platform docker image - [egeria-platform](https://hub.docker.com/r/odpi/egeria-platform). + +* Port - By default the platform uses port 9443 and exposes this port to the host environment, This means that Egeria requests +can be made to platform URL **https://localhost:9443** or, if your environment is configured to support it, it can use +the domain name of your host machine. +* SSL - By default strict SSL is set to false +* Auto-Started Servers - by default a useful set of Egeria Operational Metadata and Governance (OMAG) servers are pre-installed +and started when the Egeria platform is started. The pre-configured and started servers are: + * simple-metadata-store + * active-metadata-store + * engine-host + * integration-daemon + * view-server +A description of these servers can be found at [sample configs](open-metadata-resources/open-metadata-deployment/sample-configs/README.md) +* Content Packs - pre-constructed information sets that can be used to configure Egeria and pre-load metadata, reference data and glossary data. See [Content Packs](https://egeria-project.org/content-packs/). +* Out-of-the-box Connectors - descriptions of the integration connectors can be found at [Integration Connectors](https://egeria-project.org/connectors/). + +## Kafka - configured for Egeria +We use the bitnami/kafka image described at [kafka](https://hub.docker.com/r/bitnami/kafka) +* Port - We use the default port of 9092 for Kafka. This port is also exposed in the host environment. Changing this port also requires corresponding changes to the Egeria configuration. +* Other configuration can be seen in the *egeria-platform.yaml* file. + +# Usage +Follow these steps to use Docker Compose. + +1. Install and Configure Docker and Docker Compose. + * Docker and Docker compose must be installed and running - see https://docs.docker.com/install/ + * Configure docker with at least 6GB memory +2. Download the [**egeria-platform.yaml**](https://raw.githubusercontent.com/odpi/egeria/main/open-metadata-resources/open-metadata-deployment/docker-compose/egeria-platform-compose/egeria-platform.yaml) +3. Run the docker compose script from a terminal window in the directory where you downloaded `egeria-platform.yaml`. At the command line issue: + + `docker compose -f egeria-platform.yaml up` + +This will download the docker images for Kafka and Egeria, then create and start the two containers. Both kafka and Egeria will then automatically configure themselves. For Egeria, this means not only starting up the initial set of servers, but then loading the **CoreContentPack.omarchive** into the metadata repository, and then configuring all the servers. This can take several minutes the first time the containers are created. Subsequent startups will be much faster. + +4. Using either the **docker desktop** application or the docker command line you can see the two new containers running. To do this with the docker command line, you can issue: + +`docker ps` + +5. The environment is ready to be used. + +6. You can control the containers with docker compose commands - see [docker compose](https://docs.docker.com/reference/cli/docker/compose/). These commands can be used to administer and use the docker containers. + +## Next Steps + +Now that your Egeria environment is running and configured it is waiting for you to make requests. +Some tutorials for working with Egeria can be found at [Tutorials](https://egeria-project.org/education/tutorials/). For those that want to try the new python client, you can find a quick introduction at [pyegeria](https://getting-started-with-egeria.pdr-associates.com/recipe-6-charming-python.html). + +As always, your feedback and participation are welcome. + + +License: CC BY 4.0, Copyright Contributors to the ODPi Egeria project. \ No newline at end of file diff --git a/egeria-platform-compose/egeria-platform.yaml b/egeria-platform-compose/egeria-platform.yaml new file mode 100644 index 0000000..d959319 --- /dev/null +++ b/egeria-platform-compose/egeria-platform.yaml @@ -0,0 +1,58 @@ +--- +# SPDX-License-Identifier: Apache-2.0 +# Copyright Contributors to the Egeria project + + +# To run +# * Ensure Docker is installed and running +# * Start Egeria Platform stack using +# 'docker-compose -f ./egeria-platform.yaml up' +# +# Assumptions: +# * Ports 9443 and 9092 are available on the host system - these are the default ports for Kafka and Egeria. +# * by default, no external volumes are used - comments below give examples of using external volumes +# * by default, Egeria will start with its set of default servers (active-metadata-store,view-server, +# integration-daemon,engine-host,simple-metadata-store) - you can change this. +# * by default, strict SSL validation is turned off +# +# See the following link for more info on volumes & why we need to use root: +# https://docs.bitnami.com/containers/how-to/work-with-non-root-containers + + +services: + kafka: + image: 'bitnami/kafka:latest' + ports: + - '9092:9092' + environment: + - KAFKA_CFG_NODE_ID=0 + - KAFKA_CFG_AUTO_CREATE_TOPICS_ENABLE=true + - KAFKA_CFG_PROCESS_ROLES=controller,broker + - KAFKA_CFG_LISTENERS=PLAINTEXT://:9092,CONTROLLER://:9093 + - KAFKA_CFG_LISTENER_SECURITY_PROTOCOL_MAP=CONTROLLER:PLAINTEXT,PLAINTEXT:PLAINTEXT + - KAFKA_CFG_CONTROLLER_QUORUM_VOTERS=0@kafka:9093 + - KAFKA_CFG_CONTROLLER_LISTENER_NAMES=CONTROLLER + + egeria-platform: + depends_on: + - kafka + image: 'docker.io/odpi/egeria-platform:latest' + ports: + - '9443:9443' + + + # Persistence +# volumes: +# - "YOUR DATA DIRECTORY"/data:/deployments/data +# - "YOUR EXTRA LIBRARY DIRECTORY"/extra:/deployments/extra +# - "ANOTHER DIRECTOR TO MOUNT"/:/deployments/user_mount + + +# +# Change external to true and create volumes manually if you wish to persist between runs +# +volumes: + zookeeper-data: + external: false + kafka-data: + external: false diff --git a/egeria-platform-jupyter-compose/.env b/egeria-platform-jupyter-compose/.env new file mode 100644 index 0000000..b87c2a9 --- /dev/null +++ b/egeria-platform-jupyter-compose/.env @@ -0,0 +1 @@ + CONFIG_JSON=$(cat config.json) \ No newline at end of file diff --git a/egeria-platform-jupyter-compose/Dockerfile-jupyter b/egeria-platform-jupyter-compose/Dockerfile-jupyter new file mode 100644 index 0000000..3472451 --- /dev/null +++ b/egeria-platform-jupyter-compose/Dockerfile-jupyter @@ -0,0 +1,42 @@ +# SPDX-License-Identifier: Apache-2.0 +# Copyright Contributors to the Egeria project. + +# This build script corrects some permission issues needed to run +# on some enterprise k8s environments. see https://github.com/odpi/egeria-jupyter-notebooks/issues/9 + +# The published image tag is taken from the numerical version of +# our base image, and appended with the contents of .tag-append (file) +FROM quay.io/jupyter/scipy-notebook + +RUN pip install --no-cache-dir 'pyegeria>=0.5.5.13' +RUN pip install --no-cache-dir 'rich' +RUN pip install --no-cache-dir 'unitycatalog' +RUN pip install --no-cache-dir 'pipx' +RUN pipx ensurepath +RUN pipx install pyegeria +RUN pipx ensurepath + +RUN alias view_integ='view_integ_daemon_status --integ_url https://host.docker.internal:9443 --view_url https://host.docker.internal:9443' +RUN alias view_plat='view_platform_status --url https://host.docker.internal:9443' + +RUN mkdir -p /home/jovyan/workspaces +RUN chmod +xrw /home/jovyan/workspaces +copy ../Start-Here.md /home/jovyan +# && \ +# fix-permissions "${CONDA_DIR}" && \ +# fix-permissions "/home/${NB_USER}" \ + +#ENTRYPOINT ["jupyter","notebook"] +# +#CMD ["python3", "/config_coco_core.py"] +#USER root + +# Needed to dynamically add the selected user on startup - see link below +#RUN chmod g+w /etc/passwd +# +#RUN chown -R $NB_UID:$NB_GID $HOME +# +## https://cloud.redhat.com/blog/jupyter-on-openshift-part-6-running-as-an-assigned-user-id +#RUN chgrp -Rf root /home/$NB_USER && chmod -Rf g+w /home/$NB_USER && chgrp -Rf root /opt/conda && chmod -Rf g+w /opt/conda +# +#USER 1000 diff --git a/egeria-platform-jupyter-compose/README.md b/egeria-platform-jupyter-compose/README.md new file mode 100644 index 0000000..09299f4 --- /dev/null +++ b/egeria-platform-jupyter-compose/README.md @@ -0,0 +1,72 @@ + + + +# Open Metadata Labs - Using Docker Compose + +The open metadata labs contain an interactive environment that allow you to +experiment with different capabilities of Egeria. More information about the labs can be found at: +[Overview of the Labs](https://egeria-project.org/education/open-metadata-labs/overview/). +The labs are written using Python Jupyter notebooks that +run in a Jupyter Server. The interactive exercises in the notebooks call python functions +that communicate with Egeria. An Apache Kafka server is used by Egeria for communications. + +One way to easily deploy a running +Open Metadata Labs environment is by using the Docker Compose scripts contained in this directory. + +A docker compose script, coco-lab-setup.yaml uses docker compose to deploy, configure and run a complete working +environment that includes: + +* Three Egeria OMAG Server Platforms + * egeria-core (on port 7443) + * egeria-datalake (on port 7444) + * egeria-dev (on port 7445) +* Kafka (on port 9192) +* Jupyter Server that is used to run the lab exercises (on port 9888) + +Note that the port numbers are different from tho commonly used defaults to simplify +the coexistence of this environment in a host that may already be running Egeria, Kafka or Jupyter. +Configurations can be changed in the docker compose script `coco-lab-setup.yaml`. + +# Getting Started + +To get started, you need a computer with Docker installed and configured. Our experience is with running Docker on Mac and +Linux machines, Windows machines should also work (reach out if you run into issues). Docker can be installed from +[Docker](https://docker.com). Docker compose is installed automatically if you install Dockker Desktop. +Compatible alternatives to Docker Compose exist but have not yet been validated. + +This deployment has been testing on older machines as well as current ones. Given the number of +servers we are running, allocating at 10gb of memory for Docker is recommended. + +The startup procedure is as follows: + +1. Start docker or docker desktop +2. Download or clone the git repository containing the Egeria Open Metadata Labs + * Download - a zip file of the repository can be downloaded by pressing the green `Code` button on [](https://github.com/odpi/egeria-jupyter-notebooks) + * unzip the file in your directory of choice + * Clone - If you want to fork the repo first then change the URL to your fork. + * Ensure you have the git command line installed. + * Change to a directory you want to use as the parent of the files + * From a terminal window, issue: `git clone https://github.com/dwolfson/egeria-jupyter-notebooks.git` +3. In a terminal window, from the `egeria-jupyter-notebooks` folder, issue the commmand: + `docker compose -f coco-lab-docker-compose/coco-lab-setup.yaml up --build` + * This should produce a large amount of output as images are downloaded and started and configured. Expect the process to take a few minutes the first time and less on subsequent starts. + * You should only need the `--build` option the first time you run this command. Subsequent startup calls would just be: + `docker compose -f coco-lab-docker-compose/coco-lab-setup.yaml up` +4. Once everything is started and configured you can run the labs from the jupyter server by: + * opening a web browser to: + `http://localhost:9888/lab/tree/egeria-labs/read-me-first.ipynb` + * Type in `egeria` into the box for token or password. This will launch Jupyter in the browser. + * The `read-me-first` jupyter notebook should now be displayed. You are ready to start! + + +5. Questions, observations and other feedback are always welcome - we welcome your participation in our community: + * https://egeria-project.org/guides/community/ + + + + + + +---- +License: [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/), +Copyright Contributors to the ODPi Egeria project. diff --git a/egeria-platform-jupyter-compose/Start-Here.md b/egeria-platform-jupyter-compose/Start-Here.md new file mode 100644 index 0000000..4b85d22 --- /dev/null +++ b/egeria-platform-jupyter-compose/Start-Here.md @@ -0,0 +1,16 @@ + + +# Using the Egeria-Platform-Jupyter-Compose Environment + +If you are viewing this file in a Jupyter server then now you are ready to explore and use this basic Egeria environment. + +If you are running Jupyter, on the left hand navigation panel you should see two folders: +* work - for your own notebooks. +* workbooks - contains some starter jupyter notebooks and demos. + +These folders reside outside of the container and by default located in the `egeria-workspaces` directory that contains the scripts used to start up this environment. These locations can be changed by altering the **Docker Compose** script +`egeria-platform-jupyter-compose.yaml` using a text editor. + + + +For more information, please see [Egeria Docker Compose](https://egeria-project.org/education/open-metadata-labs/overview) \ No newline at end of file diff --git a/egeria-platform-jupyter-compose/application.properties b/egeria-platform-jupyter-compose/application.properties new file mode 100755 index 0000000..fff0e0f --- /dev/null +++ b/egeria-platform-jupyter-compose/application.properties @@ -0,0 +1,226 @@ +# SPDX-License-Identifier: Apache-2.0 +# Copyright Contributors to the ODPi Egeria project. + +# ======================================================================================================== +# The application.properties file is used to configure the OMAG Server Platform which is implemented as +# a spring boot application. + +############################################### +### Default port for the OMAG Server Platform +################################################ +server.port=9443 + +############################################### +### Set up the configuration document store the OMAG Server Platform +### The values below will set up the clear text config document store +### (the default is the encrypted config document store). +################################################ +#platform.configstore.provider=org.odpi.openmetadata.adapters.adminservices.configurationstore.file.FileBasedServerConfigStoreProvider +#platform.configstore.endpoint=data/servers/{0}/config/{0}.config + +############################################### +### Set up the platform metadata security connector that provides authorization +### for platform administration, server operations and diagnostic calls. +### By default, there is no platform metadata security connector. +### The values below are for a sample platform metadata security connector where the only userId +### that is permitted to use the administration and platform services is `garygeeke`. +############################################### +#platform.security.provider=org.odpi.openmetadata.metadatasecurity.samples.CocoPharmaPlatformSecurityProvider +#platform.security.name=Coco Pharmaceuticals Platform + +############################################### +### Set up the default configuration document for any new OMAG Server configurations. +############################################### +#platform.default.config.document=\ +# {\ +# "class": "OMAGServerConfig",\ +# "organizationName": "myOrg",\ +# "maxPageSize": 1200,\ +# "eventBusConfig": \ +# {\ +# "class": "EventBusConfig",\ +# "topicURLRoot": "egeria.omag",\ +# "configurationProperties":\ +# {\ +# "producer": {"bootstrap.servers": "{{kafkaEndpoint}}"},\ +# "consumer": {"bootstrap.servers": "{{kafkaEndpoint}}"}\ +# }\ +# }\ +# } + +################################################ +### Placeholder variables are added to field values in the configuration document +### when the server is being configured using double curly braces. They are replaced by +### the values specified in platform.placeholder.variables each time the server starts up. +### +### The "kafkaEndpoint" value is the Apache Kafka endpoint, and it is used in the active-metadata-store +### sample configuration. If your Apache Kafka broker is listening on a different endpoint +### and you want to use active-metadata-store, change this variable to your Apache Kafka's address. +################################################ +platform.placeholder.variables=\ + {\ + "kafkaEndpoint" : "localhost:9092",\ + "egeriaEndpoint" : "https://localhost:9443"\ + } + +################################################ +### startup servers configuration +################################################ +#userId used to start up the list of configured servers default is 'system' +startup.user=system +# Comma separated names of servers to be started. The server names should be unquoted. +#git startup.server.list=active-metadata-store,engine-host,integration-daemon,view-server,simple-metadata-store + +################################################ +### SSL security. +# The keystore determines the information sent out by the server to identify itself. +# The truststore is where the certificates of trusted servers the platform is calling are located. +# (Note SSL certificate checking is performed on client-side only.) +################################################ +server.ssl.key-store=keystore.p12 +server.ssl.key-store-password=egeria +server.ssl.keyStoreType=PKCS12 +server.ssl.keyAlias=egeriaserverchassis + +server.ssl.trust-store=truststore.p12 +server.ssl.trust-store-password=egeria + +# WARNING! setting 'strict.ssl=false' allows java clients to open https connections without checking the validity of +# certificates from the servers it is calling. +# Alternate you can import self-signed certificates into java truststore or set up a truststore only for this app +# by adding the store into server.ssl.trust-store parameter +strict.ssl=true + + +################################################ +# User security +################################################ + +# Authentication source (possible values: demo, ldap, ad) +authentication.source=demo +# Authentication mode (possible values: session,token,redis) +authentication.mode=token + +#token timeout in minutes +token.timeout=15 +token.absolute.timeout=720 +token.secret=doNotTell + +#LDAP authentication + +ldap.domain= +ldap.user.search.base=ou=people,dc=egeria,dc=com +ldap.user.search.filter=uid={0} +ldap.group.search.base=ou=Groups,dc=egeria,dc=com +ldap.group.search.filter=member={0} +ldap.url=ldap://localhost:389 +ldap.group.role.attribute= +ldap.npa.dn= +ldap.npa.password= +#ldap.user.dn.patterns patterns is a list of values separated by ";" as comma is used in the ldap pattern +ldap.user.dn.patterns= + +# Redis configuration +#redis.host=localhost +#redis.port=6379 + +################################################ +### Additional demo users configuration for when authentication.source=demo +### This file is located in the resources folder of the user-authn module and built into its runtime jar +################################################ +spring.config.import=classpath:demo-users.yml + +################################################ +### Comma separated list of header names to extract from incoming HTTP requests and add to thread local. +### The default value is null and adds no headers. +### Setting the list to * means all headers are captured. +### Otherwise, list the header name in use. +################################################ +authn.header.name.list= + +################################################ +### CORS +################################################ +# Comma-separated list of origins. +# Example configuration below is for setting up local development environment where egeria-ui is hosted on one of the two urls. +# cors.allowed-origins=http://localhost,http://localhost:8081 +cors.allowed-origins=* + +################################################ +# landing page (/api/public/app/info) +################################################ +app.description=Have a question? || Get in touch via our Slack community https://slack.lfai.foundation/ @@What is Open Metadata? || Find out more on our website https://egeria-project.org/ @@Have more cool ideas? || Feel free to let us know your ideas so we can make it better. +app.title=Egeria Open Metadata | Find the right data with governance + +# ############################################################## +# Component visibility for Role based access ################### +# ############################################################## +# How it works? +# +# The roles are defined in external authentication source (provider) configured with `authentication.source`. +# For demo purposes, we are providing simple file based authentication provider. See demo-users.yml +# The matrix controlling what components are allowed on the UI views for specific role is defined in the 'role.visibleComponents' prefixed properties as follows" +# +# role.visibleComponents.{ROLE-1}={component-name-1} +# role.visibleComponents.{ROLE-2}={component-name-1},{component-name-2} +# +# This will configure the application to show the component named 'component-name-1' for all uses assigned to 'ROLE-1' +# In the same way, users that have assigned 'ROLE-2' can see more 'component-name-1' and 'component-name-2'. +# It is also possible to use wildcard '*' to enable full visibility of all components to users in the given role. +# +# Complete list of components names that can be used: +# +# about +# asset-catalog +# asset-details +# asset-details-print +# glossary +# repository-explorer +# type-explorer +# asset-lineage +# asset-lineage-print +# end-to-end +# ultimate-source +# ultimate-destination +# vertical-lineage +# +# Below is the default configuration for the two COCO_PHARMA roles we use for demo: + +role.visibleComponents.COCO_PHARMA_USER=about,asset-catalog,asset-details,asset-details-print,asset-lineage,asset-lineage-print,end-to-end,ultimate-source,ultimate-destination,vertical-lineage,glossary,repository-explorer +role.visibleComponents.COCO_PHARMA_ADMIN=* + +################################################ +### Which java packages should be scanned to locate the Spring resource definitions that define the REST APIs? +################################################ +scan.packages=org.odpi.openmetadata.* + +################################################ +### Logging +################################################ +logging.level.root=OFF +logging.level.org.springframework=ERROR +logging.level.org.springframework.boot.web.embedded.tomcat=INFO +logging.level.org.odpi.openmetadata.platformchassis.springboot=INFO +#tracing REST calls +#logging.level.org.odpi.openmetadata.commonservices.ffdc.RESTCallLogger=DEBUG + +################################################ +### Swagger Docs +################################################ +springdoc.version='@springdoc.version@' +springdoc.api-docs.enabled=true +springdoc.api-docs.path=/v3/api-docs +springdoc.swagger-ui.path=/swagger-ui.html +springdoc.swagger-ui.displayRequestDuration=true +springdoc.swagger-ui.tagsSorter=alpha +springdoc.swagger-ui.operationsSorter=alpha +springdoc.swagger-ui.docExpansion=none + +################################################ +### Spring Boot Actuator +################################################ +# Endpoints web configuration +#management.endpoints.web.exposure.include=* +management.health.cassandra.enabled=false +management.health.redis.enabled=false +management.health.ldap.enabled=false \ No newline at end of file diff --git a/egeria-platform-jupyter-compose/before-notebook.d/config-coco.sh b/egeria-platform-jupyter-compose/before-notebook.d/config-coco.sh new file mode 100755 index 0000000..75423c8 --- /dev/null +++ b/egeria-platform-jupyter-compose/before-notebook.d/config-coco.sh @@ -0,0 +1,18 @@ +#!/bin/bash +# +# SPDX-License-Identifier: Apache-2.0 +# Copyright Contributors to the ODPi Egeria project. +# +# Coco Pharmaceuticals Lab Docker Compose configuration +# +# This shell script is automatically invoked when the Jupyter Container is initiated as part of the Docker Compose +# configuration.The script configures and activates the Egeria OMAG servers on each of the three Egeria OMAG Server +# Platforms that are part of the sample Coco Pharmaceuticals deployment environment. + +#export PYTHONDONTWRITEBYTECODE=1 +#python3 /home/jovyan/egeria-labs/common/config_coco_core.py +#python3 /home/jovyan/egeria-labs/common/config_coco_datalake.py +#python3 /home/jovyan/egeria-labs/common/config_coco_development.py +#echo "Launching Jupyter notebook server.." + + diff --git a/egeria-platform-jupyter-compose/egeria-platform-jupyter-compose.yaml b/egeria-platform-jupyter-compose/egeria-platform-jupyter-compose.yaml new file mode 100644 index 0000000..36ed8bd --- /dev/null +++ b/egeria-platform-jupyter-compose/egeria-platform-jupyter-compose.yaml @@ -0,0 +1,95 @@ +--- +# SPDX-License-Identifier: Apache-2.0 +# Copyright Contributors to the Egeria project + + +# To run +# * Ensure Docker is installed and running +# * Start Egeria Platform stack from the 'coco-lab-docker-compose' folder using: +# 'docker compose -f ./egeria-platform-jupyter-uc-compose.yaml up --build' +# * Subsequent startups can be performed without the '--build' at the end +# * Uninstall the containers by issuing 'docker compose -f ./egeria-platform-jupyter-uc-compose.yaml down' +# +# Assumptions: +# * Ports 7443, 7444, 7445 and 9192 are available on the host system - these are the default ports for Kafka and Egeria. +# * by default, the jupyter notebooks in the 'coco-jupyter-labs' folder are mounted and available for use by the jupyter noteboos +# * by default, strict SSL validation is turned off +# +# + +services: + jupyter-hub: + depends_on: + egeria-main: + condition: service_healthy + + image: quay.io/jupyter/scipy-notebook + container_name: jupyter-work + ports: + - 8888:8888 + environment: + JUPYTER_ENABLE_LAB: "yes" + JUPYTER_TOKEN: "egeria" + build: + dockerfile: Dockerfile-jupyter + + volumes: + - ./before-notebook.d:/usr/local/bin/before-notebook.d + - ../work:/home/jovyan/work + - ../workspaces:/home/jovyan/workspaces + + + kafka: + image: 'bitnami/kafka:latest' + ports: + - '9092:9092' + + environment: + - KAFKA_CFG_NODE_ID=0 + - KAFKA_CFG_AUTO_CREATE_TOPICS_ENABLE=true + - KAFKA_CFG_PROCESS_ROLES=controller,broker + - KAFKA_CFG_LISTENERS=PLAINTEXT://:9092,CONTROLLER://:9093 + - KAFKA_CFG_LISTENER_SECURITY_PROTOCOL_MAP=CONTROLLER:PLAINTEXT,PLAINTEXT:PLAINTEXT + - KAFKA_CFG_CONTROLLER_QUORUM_VOTERS=0@kafka:9093 + - KAFKA_CFG_CONTROLLER_LISTENER_NAMES=CONTROLLER + + + + egeria-main: + depends_on: + - kafka + image: 'egeria-platform:uc1' +# image: 'docker.io/odpi/egeria-platform:stable' + ports: + - '9443:9443' + environment: + - XTDB_ENABLE_BYTEUTILS_SHA1=True + - XTDB_DISABLE_LIBCRYPTO=True + - startup.server.list=active-metadata-store,engine-host,integration-daemon,view-server,simple-metadata-store + - server.port=9443 + + healthcheck: + test: curl -k -X GET "https://localhost:9443/open-metadata/platform-services/users/garygeeke/server-platform/origin" || exit 1 + interval: 20s + timeout: 10s + retries: 3 + start_period: 10s + start_interval: 5s + + volumes: + - ../landing_area:/deployments/landing-area + - ../logs:/deployments/logs + # - "YOUR EXTRA LIBRARY DIRECTORY"/extra:/deployments/extra + # - "ANOTHER DIRECTOR TO MOUNT"/:/deployments/user_mount + + +# +# Change external to true and create volumes manually if you wish to persist between runs +# +volumes: + zookeeper-data: + external: false + kafka-data: + external: false + db_home: + external: false diff --git a/egeria-platform-postgres-compose/README.md b/egeria-platform-postgres-compose/README.md new file mode 100644 index 0000000..4750b4f --- /dev/null +++ b/egeria-platform-postgres-compose/README.md @@ -0,0 +1,83 @@ +# Overview +This directory contains sample Docker Compose scripts to support the deployment of Egeria for experimentation, +development, and learning. Rather than having to install Egeria, prerequisites and tools separately, these scripts make +it easy to get a stack running quickly. +These are not meant for production use. Please see the [Planning Guide](https://egeria-project.org/guides/planning/) +for more information about designing Egeria deployments. The Egeria community has also created samples for other +deployment styles, such as Cloud Native approaches and the use of Helm charts to configure Kubernetes clusters. These +options may be better starting points for production deployments - depending upon your requirements. +Please feel free to engage with the community on our slack channel - we'd love your feedback and participation. + + +For a quick and simple environment to explore some of Egeria's base capabilities, the **egeria-platform.yml** Docker Compose +deployment may be a good starting point. Once this script executes successfully, you will have two docker containers running. One for the Egeria platform and one for Kafka. With this running configuration, you can work with any of Egeria's standard interfaces - java APIs, python APIs, or just plain RESTful http calls - and of course, to make use of tools and interfaces that have been built using these APIs. + +The set of **Docker Compose** configurations will grow and evolve over time to cover additional scenarios. For example, +the folder `egeria-platform-postgres-compose` contains a docker compose configuration that adds a Postgres +database along with the Egeria OMAG platform and Kafka servers. This sets the stage emerging scenarios that +utilize a relational database to collect Egeria derived information such as Audit logs for additional analysis and dashboarding. +Please see the embedded README.md files for more details. + +# Contents + +* egeria-platform-compose - a basic Egeria OMAG platform standalone deployment that includes Kafka as well as Egeria. +* egeria-platform-postgres-compose - deploys and configures a Postgres relational database as well as Kafka and Egeria. + +Our first docker compose script is called **egeria-platform.yml**. After running this script, you will have a running environment +that consists of a single Egeria runtime platform and the Apache Kafka event system. Information about configuring +Egeria can be found at [Configuring Egeria](https://egeria-project.org/guides/admin/configuring-the-omag-server-platform/). +We use standard, out-of-the-box configurations for both - a minimal amount of configuration for: + +## Egeria Platform - Default Configuration +We use the Egeria platform docker image - [egeria-platform](https://hub.docker.com/r/odpi/egeria-platform). + +* Port - By default the platform uses port 9443 and exposes this port to the host environment, This means that Egeria requests +can be made to platform URL **https://localhost:9443** or, if your environment is configured to support it, it can use +the domain name of your host machine. +* SSL - By default strict SSL is set to false +* Auto-Started Servers - by default a useful set of Egeria Operational Metadata and Governance (OMAG) servers are pre-installed +and started when the Egeria platform is started. The pre-configured and started servers are: + * simple-metadata-store + * active-metadata-store + * engine-host + * integration-daemon + * view-server +A description of these servers can be found at [sample configs](open-metadata-resources/open-metadata-deployment/sample-configs/README.md) +* Content Packs - pre-constructed information sets that can be used to configure Egeria and pre-load metadata, reference data and glossary data. See [Content Packs](https://egeria-project.org/content-packs/). +* Out-of-the-box Connectors - descriptions of the integration connectors can be found at [Integration Connectors](https://egeria-project.org/connectors/). + +## Kafka - configured for Egeria +We use the bitnami/kafka image described at [kafka](https://hub.docker.com/r/bitnami/kafka) +* Port - We use the default port of 9092 for Kafka. This port is also exposed in the host environment. Changing this port also requires corresponding changes to the Egeria configuration. +* Other configuration can be seen in the *egeria-platform.yaml* file. + +# Usage +Follow these steps to use Docker Compose. + +1. Install and Configure Docker and Docker Compose. + * Docker and Docker compose must be installed and running - see https://docs.docker.com/install/ + * Configure docker with at least 6GB memory +2. Download the [**egeria-platform.yaml**](https://raw.githubusercontent.com/odpi/egeria/main/open-metadata-resources/open-metadata-deployment/docker-compose/egeria-platform-compose/egeria-platform.yaml) +3. Run the docker compose script from a terminal window in the directory where you downloaded `egeria-platform.yaml`. At the command line issue: + + `docker compose -f egeria-platform.yaml up` + +This will download the docker images for Kafka and Egeria, then create and start the two containers. Both kafka and Egeria will then automatically configure themselves. For Egeria, this means not only starting up the initial set of servers, but then loading the **CoreContentPack.omarchive** into the metadata repository, and then configuring all the servers. This can take several minutes the first time the containers are created. Subsequent startups will be much faster. + +4. Using either the **docker desktop** application or the docker command line you can see the two new containers running. To do this with the docker command line, you can issue: + +`docker ps` + +5. The environment is ready to be used. + +6. You can control the containers with docker compose commands - see [docker compose](https://docs.docker.com/reference/cli/docker/compose/). These commands can be used to administer and use the docker containers. + +## Next Steps + +Now that your Egeria environment is running and configured it is waiting for you to make requests. +Some tutorials for working with Egeria can be found at [Tutorials](https://egeria-project.org/education/tutorials/). For those that want to try the new python client, you can find a quick introduction at [pyegeria](https://getting-started-with-egeria.pdr-associates.com/recipe-6-charming-python.html). + +As always, your feedback and participation are welcome. + + +License: CC BY 4.0, Copyright Contributors to the ODPi Egeria project. \ No newline at end of file diff --git a/egeria-platform-postgres-compose/docker-entrypoint-initdb.d/init_egeria_observations.sql b/egeria-platform-postgres-compose/docker-entrypoint-initdb.d/init_egeria_observations.sql new file mode 100644 index 0000000..9e01408 --- /dev/null +++ b/egeria-platform-postgres-compose/docker-entrypoint-initdb.d/init_egeria_observations.sql @@ -0,0 +1,126 @@ +create user egeria_admin with superuser login password 'admin4egeria'; +create user egeria_user with login password 'user4egeria'; +create database egeria_observations; + +grant all privileges on database egeria_observations to egeria_admin, egeria_user; + + +\c egeria_observations; +create schema open_metadata; +create schema audit_log; +grant all on schema open_metadata, audit_log to egeria_admin, egeria_user; + +DROP TABLE IF EXISTS audit_log.al_api_calls; +CREATE TABLE audit_log.al_api_calls (thread_id BIGINT NOT NULL, server_name TEXT NOT NULL, user_name TEXT NOT NULL, operation_name TEXT NOT NULL, service_name TEXT NOT NULL, call_time TIMESTAMP(6) WITHOUT TIME ZONE NOT NULL); +COMMENT ON TABLE audit_log.al_api_calls IS 'Calls to Egeria REST APIs'; +COMMENT ON COLUMN audit_log.al_api_calls.thread_id IS 'Thread running the request'; +COMMENT ON COLUMN audit_log.al_api_calls.server_name IS 'Name of the called server'; +COMMENT ON COLUMN audit_log.al_api_calls.user_name IS 'Identifier of calling user'; +COMMENT ON COLUMN audit_log.al_api_calls.operation_name IS 'Name of the called method'; +COMMENT ON COLUMN audit_log.al_api_calls.service_name IS 'The service supporting the called method'; +COMMENT ON COLUMN audit_log.al_api_calls.call_time IS 'Time that the request was made.'; +DROP TABLE IF EXISTS audit_log.al_asset_activity; +CREATE TABLE audit_log.al_asset_activity (thread_id BIGINT NOT NULL, server_name TEXT NOT NULL, call_time TIMESTAMP(6) WITHOUT TIME ZONE NOT NULL, asset_operation TEXT NOT NULL, asset_guid TEXT NOT NULL, asset_type TEXT NOT NULL, operation_name TEXT NOT NULL, service_name TEXT NOT NULL, user_name TEXT NOT NULL); +COMMENT ON TABLE audit_log.al_asset_activity IS 'User activity around an om_asset'; +COMMENT ON COLUMN audit_log.al_asset_activity.thread_id IS 'Thread where the request ran'; +COMMENT ON COLUMN audit_log.al_asset_activity.server_name IS 'Name of the called server'; +COMMENT ON COLUMN audit_log.al_asset_activity.call_time IS 'Time thatthe request was made'; +COMMENT ON COLUMN audit_log.al_asset_activity.asset_operation IS 'Create, Update, Delete, Attachment, Feedback'; +COMMENT ON COLUMN audit_log.al_asset_activity.asset_guid IS 'Unique identifier of the om_asset'; +COMMENT ON COLUMN audit_log.al_asset_activity.asset_type IS 'Type of the om_asset'; +COMMENT ON COLUMN audit_log.al_asset_activity.operation_name IS 'Called method'; +COMMENT ON COLUMN audit_log.al_asset_activity.service_name IS 'Name of the called service'; +COMMENT ON COLUMN audit_log.al_asset_activity.user_name IS 'Name of the requesting user.'; +DROP TABLE IF EXISTS audit_log.al_audit_events; +CREATE TABLE audit_log.al_audit_events (message_ts TIMESTAMP(6) WITHOUT TIME ZONE NOT NULL, server_name TEXT, action_description TEXT, severity_code TEXT, severity TEXT, message_id TEXT, message_text TEXT, message_parameters TEXT, system_action TEXT, user_action TEXT, exception_class_name TEXT, exception_message TEXT, exception_stacktrace TEXT, organization TEXT, component_name TEXT, additional_info TEXT, log_record_id TEXT NOT NULL, thread_id BIGINT, CONSTRAINT audit_events_pk PRIMARY KEY (log_record_id, message_ts)); +COMMENT ON COLUMN audit_log.al_audit_events.thread_id IS 'Thread where the request ran'; +DROP TABLE IF EXISTS audit_log.al_egeria_components; +CREATE TABLE audit_log.al_egeria_components (component_id INTEGER NOT NULL, development_status CHARACTER VARYING(20), component_name TEXT, component_description TEXT, component_wiki_url TEXT, CONSTRAINT egeriacomponents_ix1 UNIQUE (component_id)); +DROP TABLE IF EXISTS audit_log.al_egeria_exceptions; +CREATE TABLE audit_log.al_egeria_exceptions (exception_class_name TEXT NOT NULL, exception_message TEXT NOT NULL, system_action TEXT NOT NULL, user_action TEXT NOT NULL, message_ts TEXT NOT NULL, log_record_id TEXT NOT NULL, CONSTRAINT egeria_exceptions_pk PRIMARY KEY (log_record_id)); +COMMENT ON COLUMN audit_log.al_egeria_exceptions.message_ts IS 'Timestamp of log record'; +COMMENT ON COLUMN audit_log.al_egeria_exceptions.log_record_id IS 'Unique identifier of the reporting log record.'; +DROP TABLE IF EXISTS audit_log.al_omag_servers; +CREATE TABLE audit_log.al_omag_servers (server_name TEXT NOT NULL, server_type TEXT, organization TEXT, metadata_collection_id TEXT, CONSTRAINT omag_servers_pk PRIMARY KEY (server_name)); +COMMENT ON COLUMN audit_log.al_omag_servers.server_name IS 'Name of the server'; +COMMENT ON COLUMN audit_log.al_omag_servers.server_type IS 'Type of server'; +COMMENT ON COLUMN audit_log.al_omag_servers.organization IS 'Name ofthe organization that runs this server.'; +COMMENT ON COLUMN audit_log.al_omag_servers.metadata_collection_id IS 'Identifier for the metadata collection beinf maintained by this server'; + +DROP TABLE IF EXISTS open_metadata.om_asset; +CREATE TABLE open_metadata.om_asset (resource_name TEXT, resource_description TEXT, version_id TEXT, display_name TEXT, display_description TEXT, asset_guid TEXT NOT NULL, qualified_name TEXT NOT NULL, display_summary TEXT, abbrev TEXT, usage TEXT, additional_properties TEXT, owner_guid TEXT, owner_type TEXT, origin_org_guid TEXT, origin_biz_cap_guid TEXT, zone_names TEXT, asset_type TEXT NOT NULL, resource_loc_guid TEXT, confidentiality INTEGER, confidence INTEGER, criticality INTEGER, metadata_collection_id TEXT NOT NULL, license_guid TEXT, sync_time TIMESTAMP(6) WITHOUT TIME ZONE NOT NULL, last_update_timestamp TIMESTAMP(6) WITHOUT TIME ZONE, last_updated_by TEXT, creation_timestamp TIMESTAMP(6) WITHOUT TIME ZONE NOT NULL, created_by TEXT, maintained_by TEXT, archived TIMESTAMP(6) WITHOUT TIME ZONE, tags TEXT, semantic_term TEXT, PRIMARY KEY (asset_guid, sync_time)); +COMMENT ON TABLE open_metadata.om_asset IS 'Assets catalogued in the Egeria ecosystem'; +COMMENT ON COLUMN open_metadata.om_asset.sync_time IS 'The time at which egeria update this row.'; +DROP TABLE IF EXISTS open_metadata.om_asset_types; +CREATE TABLE open_metadata.om_asset_types (leaf_type TEXT NOT NULL, type_description TEXT, super_types JSONB, CONSTRAINT asset_types_pk PRIMARY KEY (leaf_type)); +DROP TABLE IF EXISTS open_metadata.om_certification_type; +CREATE TABLE open_metadata.om_certification_type (certification_type_guid TEXT NOT NULL, certification_title TEXT NOT NULL, certification_summary TEXT, PRIMARY KEY (certification_type_guid)); +COMMENT ON TABLE open_metadata.om_certification_type IS 'map certification guids to names'; +DROP TABLE IF EXISTS open_metadata.om_certifications; +CREATE TABLE open_metadata.om_certifications (referenceable_guid TEXT NOT NULL, certification_guid TEXT NOT NULL, certification_type_guid TEXT NOT NULL, start_date DATE, end_date DATE, sync_time TIMESTAMP(6) WITHOUT TIME ZONE NOT NULL, PRIMARY KEY (certification_guid, sync_time)); +COMMENT ON TABLE open_metadata.om_certifications IS 'om_certifications associated wtih assets'; +DROP TABLE IF EXISTS open_metadata.om_collaboration_activity; +CREATE TABLE open_metadata.om_collaboration_activity (element_guid TEXT NOT NULL, sync_time TIMESTAMP(6) WITHOUT TIME ZONE NOT NULL, num_comments INTEGER, num_ratings INTEGER, avg_rating INTEGER, num_tags INTEGER, num_likes INTEGER, PRIMARY KEY (element_guid, sync_time)); +COMMENT ON TABLE open_metadata.om_collaboration_activity IS 'Track the user feedback over time'; +COMMENT ON COLUMN open_metadata.om_collaboration_activity.element_guid IS 'Either an om_asset or glossary element'; +COMMENT ON COLUMN open_metadata.om_collaboration_activity.sync_time IS 'The last time that the information was updated in the database by Egeria.'; +DROP TABLE IF EXISTS open_metadata.om_context_event_types; +CREATE TABLE open_metadata.om_context_event_types (guid TEXT NOT NULL, qualified_name TEXT NOT NULL, ce_type_name TEXT NOT NULL, description TEXT); +DROP TABLE IF EXISTS open_metadata.om_context_events; +CREATE TABLE open_metadata.om_context_events (guid TEXT NOT NULL, qualified_name TEXT NOT NULL, display_name TEXT NOT NULL, description TEXT, event_effect TEXT, context_event_type TEXT NOT NULL, planned_start_date DATE, planned_duration NUMERIC, actual_duration NUMERIC, repeat_interval NUMERIC, planned_completion_date DATE, actual_completion_date DATE, reference_effective_from DATE, reference_effective_to DATE, additional_properties TEXT); +DROP TABLE IF EXISTS open_metadata.om_contributions; +CREATE TABLE open_metadata.om_contributions (user_guid TEXT NOT NULL, snapshot_timestamp TIMESTAMP(6) WITHOUT TIME ZONE NOT NULL, karma_points BIGINT, PRIMARY KEY (user_guid, snapshot_timestamp)); +COMMENT ON TABLE open_metadata.om_contributions IS 'This reflects the om_contributions per user over time.'; +DROP TABLE IF EXISTS open_metadata.om_correlation_properties; +CREATE TABLE open_metadata.om_correlation_properties (external_identifier TEXT NOT NULL, last_updated_by TEXT, last_update_time TIMESTAMP(6) WITHOUT TIME ZONE, created_by TEXT, version BIGINT, creation_time TIMESTAMP(6) WITHOUT TIME ZONE, type_name TEXT, egeria_owned BOOLEAN NOT NULL, additional_properties TEXT, element_guid TEXT NOT NULL, external_source_guid TEXT NOT NULL, last_confirmed_sync_time TIMESTAMP(6) WITHOUT TIME ZONE NOT NULL, PRIMARY KEY (external_identifier, element_guid, external_source_guid, last_confirmed_sync_time)); +COMMENT ON TABLE open_metadata.om_correlation_properties IS 'most of the information comes from external_id entity that represents an instance in a 3rd party catalog. This includes the user information from that third party.'; +DROP TABLE IF EXISTS open_metadata.om_data_fields; +CREATE TABLE open_metadata.om_data_fields (data_field_guid TEXT NOT NULL, data_field_name TEXT, version_id CHARACTER VARYING(80), semantic_term CHARACTER VARYING(80), has_profile BOOLEAN, confidentiality_level INTEGER, asset_qualified_name TEXT, asset_guid TEXT NOT NULL, sync_time TIMESTAMP(6) WITHOUT TIME ZONE NOT NULL, PRIMARY KEY (data_field_guid, sync_time)); +DROP TABLE IF EXISTS open_metadata.om_department; +CREATE TABLE open_metadata.om_department (dep_id CHARACTER VARYING(40) NOT NULL, dep_name TEXT, manager CHARACTER VARYING(40), parent_department TEXT, sync_time TIMESTAMP(6) WITHOUT TIME ZONE NOT NULL, PRIMARY KEY (dep_id, sync_time)); +COMMENT ON TABLE open_metadata.om_department IS 'Maps Department codes to Department names'; +DROP TABLE IF EXISTS open_metadata.om_external_audit_logs; +CREATE TABLE open_metadata.om_external_audit_logs (metadata_collection_id TEXT NOT NULL, external_identifier TEXT NOT NULL, activity_timestamp TIMESTAMP(6) WITHOUT TIME ZONE NOT NULL, activity_type TEXT, user_id TEXT, event_key TEXT, PRIMARY KEY (metadata_collection_id, external_identifier, activity_timestamp)); +DROP TABLE IF EXISTS open_metadata.om_external_user; +CREATE TABLE open_metadata.om_external_user (metadata_collection_id TEXT NOT NULL, external_user TEXT NOT NULL, user_id_guid TEXT, start_time TIMESTAMP(6) WITHOUT TIME ZONE, end_time TIMESTAMP(6) WITHOUT TIME ZONE, PRIMARY KEY (metadata_collection_id, external_user)); +COMMENT ON TABLE open_metadata.om_external_user IS 'Capture the user information from external systems that may or may not have mapped identities with Egeria.'; +DROP TABLE IF EXISTS open_metadata.om_glossary; +CREATE TABLE open_metadata.om_glossary (glossary_name TEXT, glossary_language TEXT, classifications TEXT, glossary_description TEXT, glossary_guid TEXT NOT NULL, qualified_name TEXT NOT NULL, number_terms BIGINT, number_categories INTEGER, num_linked_terms BIGINT, usage TEXT, additional_properties TEXT, owner_guid TEXT, owner_type TEXT, metadata_collection_id TEXT, license_guid TEXT, last_update_timestamp TIMESTAMP(6) WITHOUT TIME ZONE, creation_timestamp TIMESTAMP(6) WITHOUT TIME ZONE NOT NULL, sync_time TIMESTAMP(6) WITHOUT TIME ZONE NOT NULL, PRIMARY KEY (glossary_guid, sync_time)); +COMMENT ON TABLE open_metadata.om_glossary IS 'Glossaries catalogued in the Egeria ecosystem'; +COMMENT ON COLUMN open_metadata.om_glossary.last_update_timestamp IS 'This is the last update time from the glossary element.'; +DROP TABLE IF EXISTS open_metadata.om_license; +CREATE TABLE open_metadata.om_license (license_guid TEXT NOT NULL, license_name TEXT, license_description TEXT, PRIMARY KEY (license_guid)); +DROP TABLE IF EXISTS open_metadata.om_location; +CREATE TABLE open_metadata.om_location (location_guid TEXT NOT NULL, location_name TEXT, location_type TEXT, PRIMARY KEY (location_guid)); +DROP TABLE IF EXISTS open_metadata.om_metadata_collection; +CREATE TABLE open_metadata.om_metadata_collection (metadata_collection_id TEXT NOT NULL, metadata_collection_name TEXT, metadata_collection_type CHARACTER VARYING(40), deployed_impl_type TEXT, PRIMARY KEY (metadata_collection_id)); +COMMENT ON COLUMN open_metadata.om_metadata_collection.metadata_collection_type IS 'local cohort vs external source etc - instance provenance type'; +COMMENT ON COLUMN open_metadata.om_metadata_collection.deployed_impl_type IS 'This is the type of system (postgres vs db2 vs atlas)'; +DROP TABLE IF EXISTS open_metadata.om_reference_levels; +CREATE TABLE open_metadata.om_reference_levels (identifier INTEGER NOT NULL, classification_name TEXT NOT NULL, display_name TEXT, text TEXT, PRIMARY KEY (identifier, classification_name)); +COMMENT ON TABLE open_metadata.om_reference_levels IS 'A table to hold the different reference levels for confidentiality, confidence, criticality etc.'; +DROP TABLE IF EXISTS open_metadata.om_related_assets; +CREATE TABLE open_metadata.om_related_assets (end1_guid TEXT NOT NULL, end2_guid TEXT NOT NULL, end1_attribute_nm TEXT, end2_attribute_nm TEXT, rel_type_nm TEXT, sync_time TIMESTAMP(6) WITHOUT TIME ZONE NOT NULL, relationship_guid TEXT NOT NULL, PRIMARY KEY (relationship_guid, sync_time)); +DROP TABLE IF EXISTS open_metadata.om_role; +CREATE TABLE open_metadata.om_role (role_guid TEXT NOT NULL, role_name TEXT, role_type TEXT, headcount INTEGER, sync_time TIMESTAMP(6) WITHOUT TIME ZONE NOT NULL, PRIMARY KEY (role_guid, sync_time)); +DROP TABLE IF EXISTS open_metadata.om_role2user; +CREATE TABLE open_metadata.om_role2user (role_guid TEXT NOT NULL, user_guid TEXT NOT NULL, sync_time TIMESTAMP(6) WITHOUT TIME ZONE NOT NULL, start_date TIMESTAMP(6) WITHOUT TIME ZONE, end_date TIMESTAMP(6) WITHOUT TIME ZONE, relationship_guid TEXT NOT NULL, PRIMARY KEY (relationship_guid, sync_time)); +COMMENT ON TABLE open_metadata.om_role2user IS 'Mapping of roles to users'; +DROP TABLE IF EXISTS open_metadata.om_term_activity; +CREATE TABLE open_metadata.om_term_activity (term_name TEXT, term_guid TEXT NOT NULL, qualified_name TEXT NOT NULL, term_summary TEXT, version_id TEXT, owner_guid TEXT, owner_type TEXT, confidentiality INTEGER, confidence INTEGER, criticality INTEGER, last_feedback_timestamp TIMESTAMP(6) WITHOUT TIME ZONE, creation_timestamp TIMESTAMP(6) WITHOUT TIME ZONE, number_linked_element INTEGER, last_link_timestamp TIMESTAMP(6) WITHOUT TIME ZONE, sync_time TIMESTAMP(6) WITHOUT TIME ZONE NOT NULL, glossary_guid TEXT NOT NULL, PRIMARY KEY (term_guid, sync_time)); +COMMENT ON TABLE open_metadata.om_term_activity IS 'Term activity - '; +COMMENT ON COLUMN open_metadata.om_term_activity.last_feedback_timestamp IS 'Time of last feedback update on this term'; +COMMENT ON COLUMN open_metadata.om_term_activity.glossary_guid IS 'This is the owning glossary rather than where the term might show up.'; +DROP TABLE IF EXISTS open_metadata.om_todo; +CREATE TABLE open_metadata.om_todo (todo_guid TEXT NOT NULL, qualified_name TEXT, display_name TEXT, creation_time TIMESTAMP(6) WITHOUT TIME ZONE, todo_type TEXT, priority INTEGER, due_time TIMESTAMP(6) WITHOUT TIME ZONE, completion_time TIMESTAMP(6) WITHOUT TIME ZONE, status TEXT, todo_source_guid TEXT, todo_source_type TEXT, last_reviewed_time TIMESTAMP(6) WITHOUT TIME ZONE, sync_time TIMESTAMP(6) WITHOUT TIME ZONE NOT NULL, actor_guid TEXT, actor_type TEXT, CONSTRAINT om_todo_pk PRIMARY KEY (sync_time, todo_guid)); +COMMENT ON TABLE open_metadata.om_todo IS 'Represent all todos independent of source. The actual implementation of the todo might be in an external system, in which case we would map their external identifiers to our todos through the om_correlation_properties table.'; +COMMENT ON COLUMN open_metadata.om_todo.actor_guid IS 'The unique identifier of the actor assigned to perform this ToDo. An Actor is either a UserId, Profile, or PersonRole.'; +COMMENT ON COLUMN open_metadata.om_todo.actor_type IS 'Type name of actor'; +DROP TABLE IF EXISTS open_metadata.om_user_identity; +CREATE TABLE open_metadata.om_user_identity (employee_num CHARACTER VARYING(80), user_id CHARACTER VARYING(80) NOT NULL, preferred_name CHARACTER VARYING(80), org_name CHARACTER VARYING(80), resident_country CHARACTER VARYING(80), location CHARACTER VARYING(80), distinguished_name CHARACTER VARYING(80), user_id_guid CHARACTER VARYING(80) NOT NULL, profile_guid CHARACTER VARYING(80), department_id CHARACTER VARYING(40), sync_time TIMESTAMP(6) WITHOUT TIME ZONE NOT NULL, PRIMARY KEY (user_id_guid, sync_time)); +COMMENT ON TABLE open_metadata.om_user_identity IS 'registered users'; +DROP TABLE IF EXISTS open_metadata.rd_file_classifiers; +CREATE TABLE open_metadata.rd_file_classifiers (sr_guid TEXT NOT NULL, filename TEXT NOT NULL, file_extension TEXT, pathname TEXT NOT NULL, file_type TEXT, asset_type TEXT, deployed_implementation_type TEXT, encoding TEXT, sync_time TIMESTAMP(6) WITHOUT TIME ZONE NOT NULL, CONSTRAINT rd_file_classifiers_pk PRIMARY KEY (pathname, sync_time)); + + + diff --git a/egeria-platform-postgres-compose/egeria-platform-postgres.yaml b/egeria-platform-postgres-compose/egeria-platform-postgres.yaml new file mode 100644 index 0000000..45fcf8b --- /dev/null +++ b/egeria-platform-postgres-compose/egeria-platform-postgres.yaml @@ -0,0 +1,71 @@ +--- +# SPDX-License-Identifier: Apache-2.0 +# Copyright Contributors to the Egeria project + + +# To run +# * Ensure Docker is installed and running +# * Start Egeria Platform stack using +# 'docker-compose -f ./egeria-platform-postgres.yaml up' +# +# Assumptions: +# * Ports 9443 and 9092 are available on the host system - these are the default ports for Kafka and Egeria. +# * by default, no external volumes are used - comments below give examples of using external volumes +# * by default, Egeria will start with its set of default servers (active-metadata-store,view-server, +# integration-daemon,engine-host,simple-metadata-store) - you can change this. +# * by default, strict SSL validation is turned off +# +# See the following link for more info on volumes & why we need to use root: +# https://docs.bitnami.com/containers/how-to/work-with-non-root-containers + + +services: + kafka: + image: 'bitnami/kafka:latest' + ports: + - '9092:9092' + environment: + - KAFKA_CFG_NODE_ID=0 + - KAFKA_CFG_AUTO_CREATE_TOPICS_ENABLE=true + - KAFKA_CFG_PROCESS_ROLES=controller,broker + - KAFKA_CFG_LISTENERS=PLAINTEXT://:9092,CONTROLLER://:9093 + - KAFKA_CFG_LISTENER_SECURITY_PROTOCOL_MAP=CONTROLLER:PLAINTEXT,PLAINTEXT:PLAINTEXT + - KAFKA_CFG_CONTROLLER_QUORUM_VOTERS=0@kafka:9093 + - KAFKA_CFG_CONTROLLER_LISTENER_NAMES=CONTROLLER + + egeria-platform: + depends_on: + - kafka + image: 'docker.io/odpi/egeria-platform:latest' + ports: + - '9443:9443' + # volumes: + # - "YOUR DATA DIRECTORY"/data:/deployments/data + # - "YOUR EXTRA LIBRARY DIRECTORY"/extra:/deployments/extra + # - "ANOTHER DIRECTOR TO MOUNT"/:/deployments/user_mount + + postgres: + image: postgres:latest + container_name: observations + restart: always + ports: + - "127.0.0.1:5432:5432" + + shm_size: 128mb + environment: + POSTGRES_PASSWORD: notingres + volumes: + - db_home:/var/lib/postgresql/data + - ./docker-entrypoint-initdb.d:/docker-entrypoint-initdb.d + + +# +# Change external to true and create volumes manually if you wish to persist between runs +# +volumes: + zookeeper-data: + external: false + kafka-data: + external: false + db_home: + external: false diff --git a/gradle.properties b/gradle.properties deleted file mode 100644 index 8b6f356..0000000 --- a/gradle.properties +++ /dev/null @@ -1,30 +0,0 @@ -# SPDX-License-Identifier: Apache-2.0 -# Copyright Contributors to the ODPi Egeria project. - -# Allow parallel builds (defaults will be 1 per CPU thread) -org.gradle.parallel=true - -# Caching -org.gradle.caching=true - -# Watch fileystem - disable - too many files swamps OS -org.gradle.vfs.watch=true - -# Default logging output -org.gradle.console=auto - -# Stop if we get a warning -org.gradle.warning.mode=summary - -# Defer configuration until needed -org.gradle.configureondemand=true - -# Increase memory to 4GB -org.gradle.jvmargs=-Xmx4096m - -# If system is quiet, all cpu will be used anyway. But on interactive desktop this will -# help keep system responsive whilst a build is running -org.gradle.priority=low - -# Timeout the daemon after an hour -org.gradle.daemon.idletimeout=3600000 diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar deleted file mode 100644 index ccebba7..0000000 Binary files a/gradle/wrapper/gradle-wrapper.jar and /dev/null differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties deleted file mode 100644 index bdc9a83..0000000 --- a/gradle/wrapper/gradle-wrapper.properties +++ /dev/null @@ -1,6 +0,0 @@ -distributionBase=GRADLE_USER_HOME -distributionPath=wrapper/dists -distributionUrl=https\://services.gradle.org/distributions/gradle-8.0.2-bin.zip -networkTimeout=10000 -zipStoreBase=GRADLE_USER_HOME -zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew deleted file mode 100755 index 79a61d4..0000000 --- a/gradlew +++ /dev/null @@ -1,244 +0,0 @@ -#!/bin/sh - -# -# Copyright © 2015-2021 the original authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# https://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# - -############################################################################## -# -# Gradle start up script for POSIX generated by Gradle. -# -# Important for running: -# -# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is -# noncompliant, but you have some other compliant shell such as ksh or -# bash, then to run this script, type that shell name before the whole -# command line, like: -# -# ksh Gradle -# -# Busybox and similar reduced shells will NOT work, because this script -# requires all of these POSIX shell features: -# * functions; -# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», -# «${var#prefix}», «${var%suffix}», and «$( cmd )»; -# * compound commands having a testable exit status, especially «case»; -# * various built-in commands including «command», «set», and «ulimit». -# -# Important for patching: -# -# (2) This script targets any POSIX shell, so it avoids extensions provided -# by Bash, Ksh, etc; in particular arrays are avoided. -# -# The "traditional" practice of packing multiple parameters into a -# space-separated string is a well documented source of bugs and security -# problems, so this is (mostly) avoided, by progressively accumulating -# options in "$@", and eventually passing that to Java. -# -# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, -# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; -# see the in-line comments for details. -# -# There are tweaks for specific operating systems such as AIX, CygWin, -# Darwin, MinGW, and NonStop. -# -# (3) This script is generated from the Groovy template -# https://github.com/gradle/gradle/blob/HEAD/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt -# within the Gradle project. -# -# You can find Gradle at https://github.com/gradle/gradle/. -# -############################################################################## - -# Attempt to set APP_HOME - -# Resolve links: $0 may be a link -app_path=$0 - -# Need this for daisy-chained symlinks. -while - APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path - [ -h "$app_path" ] -do - ls=$( ls -ld "$app_path" ) - link=${ls#*' -> '} - case $link in #( - /*) app_path=$link ;; #( - *) app_path=$APP_HOME$link ;; - esac -done - -# This is normally unused -# shellcheck disable=SC2034 -APP_BASE_NAME=${0##*/} -APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit - -# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. -DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' - -# Use the maximum available, or set MAX_FD != -1 to use that value. -MAX_FD=maximum - -warn () { - echo "$*" -} >&2 - -die () { - echo - echo "$*" - echo - exit 1 -} >&2 - -# OS specific support (must be 'true' or 'false'). -cygwin=false -msys=false -darwin=false -nonstop=false -case "$( uname )" in #( - CYGWIN* ) cygwin=true ;; #( - Darwin* ) darwin=true ;; #( - MSYS* | MINGW* ) msys=true ;; #( - NONSTOP* ) nonstop=true ;; -esac - -CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar - - -# Determine the Java command to use to start the JVM. -if [ -n "$JAVA_HOME" ] ; then - if [ -x "$JAVA_HOME/jre/sh/java" ] ; then - # IBM's JDK on AIX uses strange locations for the executables - JAVACMD=$JAVA_HOME/jre/sh/java - else - JAVACMD=$JAVA_HOME/bin/java - fi - if [ ! -x "$JAVACMD" ] ; then - die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME - -Please set the JAVA_HOME variable in your environment to match the -location of your Java installation." - fi -else - JAVACMD=java - which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. - -Please set the JAVA_HOME variable in your environment to match the -location of your Java installation." -fi - -# Increase the maximum file descriptors if we can. -if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then - case $MAX_FD in #( - max*) - # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. - # shellcheck disable=SC3045 - MAX_FD=$( ulimit -H -n ) || - warn "Could not query maximum file descriptor limit" - esac - case $MAX_FD in #( - '' | soft) :;; #( - *) - # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. - # shellcheck disable=SC3045 - ulimit -n "$MAX_FD" || - warn "Could not set maximum file descriptor limit to $MAX_FD" - esac -fi - -# Collect all arguments for the java command, stacking in reverse order: -# * args from the command line -# * the main class name -# * -classpath -# * -D...appname settings -# * --module-path (only if needed) -# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. - -# For Cygwin or MSYS, switch paths to Windows format before running java -if "$cygwin" || "$msys" ; then - APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) - CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) - - JAVACMD=$( cygpath --unix "$JAVACMD" ) - - # Now convert the arguments - kludge to limit ourselves to /bin/sh - for arg do - if - case $arg in #( - -*) false ;; # don't mess with options #( - /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath - [ -e "$t" ] ;; #( - *) false ;; - esac - then - arg=$( cygpath --path --ignore --mixed "$arg" ) - fi - # Roll the args list around exactly as many times as the number of - # args, so each arg winds up back in the position where it started, but - # possibly modified. - # - # NB: a `for` loop captures its iteration list before it begins, so - # changing the positional parameters here affects neither the number of - # iterations, nor the values presented in `arg`. - shift # remove old arg - set -- "$@" "$arg" # push replacement arg - done -fi - -# Collect all arguments for the java command; -# * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of -# shell script including quotes and variable substitutions, so put them in -# double quotes to make sure that they get re-expanded; and -# * put everything else in single quotes, so that it's not re-expanded. - -set -- \ - "-Dorg.gradle.appname=$APP_BASE_NAME" \ - -classpath "$CLASSPATH" \ - org.gradle.wrapper.GradleWrapperMain \ - "$@" - -# Stop when "xargs" is not available. -if ! command -v xargs >/dev/null 2>&1 -then - die "xargs is not available" -fi - -# Use "xargs" to parse quoted args. -# -# With -n1 it outputs one arg per line, with the quotes and backslashes removed. -# -# In Bash we could simply go: -# -# readarray ARGS < <( xargs -n1 <<<"$var" ) && -# set -- "${ARGS[@]}" "$@" -# -# but POSIX shell has neither arrays nor command substitution, so instead we -# post-process each arg (as a line of input to sed) to backslash-escape any -# character that might be a shell metacharacter, then use eval to reverse -# that process (while maintaining the separation between arguments), and wrap -# the whole thing up as a single "set" statement. -# -# This will of course break if any of these variables contains a newline or -# an unmatched quote. -# - -eval "set -- $( - printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | - xargs -n1 | - sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | - tr '\n' ' ' - )" '"$@"' - -exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat deleted file mode 100644 index 6689b85..0000000 --- a/gradlew.bat +++ /dev/null @@ -1,92 +0,0 @@ -@rem -@rem Copyright 2015 the original author or authors. -@rem -@rem Licensed under the Apache License, Version 2.0 (the "License"); -@rem you may not use this file except in compliance with the License. -@rem You may obtain a copy of the License at -@rem -@rem https://www.apache.org/licenses/LICENSE-2.0 -@rem -@rem Unless required by applicable law or agreed to in writing, software -@rem distributed under the License is distributed on an "AS IS" BASIS, -@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -@rem See the License for the specific language governing permissions and -@rem limitations under the License. -@rem - -@if "%DEBUG%"=="" @echo off -@rem ########################################################################## -@rem -@rem Gradle startup script for Windows -@rem -@rem ########################################################################## - -@rem Set local scope for the variables with windows NT shell -if "%OS%"=="Windows_NT" setlocal - -set DIRNAME=%~dp0 -if "%DIRNAME%"=="" set DIRNAME=. -@rem This is normally unused -set APP_BASE_NAME=%~n0 -set APP_HOME=%DIRNAME% - -@rem Resolve any "." and ".." in APP_HOME to make it shorter. -for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi - -@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. -set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" - -@rem Find java.exe -if defined JAVA_HOME goto findJavaFromJavaHome - -set JAVA_EXE=java.exe -%JAVA_EXE% -version >NUL 2>&1 -if %ERRORLEVEL% equ 0 goto execute - -echo. -echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. -echo. -echo Please set the JAVA_HOME variable in your environment to match the -echo location of your Java installation. - -goto fail - -:findJavaFromJavaHome -set JAVA_HOME=%JAVA_HOME:"=% -set JAVA_EXE=%JAVA_HOME%/bin/java.exe - -if exist "%JAVA_EXE%" goto execute - -echo. -echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% -echo. -echo Please set the JAVA_HOME variable in your environment to match the -echo location of your Java installation. - -goto fail - -:execute -@rem Setup the command line - -set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar - - -@rem Execute Gradle -"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* - -:end -@rem End local scope for the variables with windows NT shell -if %ERRORLEVEL% equ 0 goto mainEnd - -:fail -rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of -rem the _cmd.exe /c_ return code! -set EXIT_CODE=%ERRORLEVEL% -if %EXIT_CODE% equ 0 set EXIT_CODE=1 -if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% -exit /b %EXIT_CODE% - -:mainEnd -if "%OS%"=="Windows_NT" endlocal - -:omega diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..6518d8b --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,18 @@ +[tool.poetry] +name = "egeria-workspaces" +version = "0.1.0" +description = "" +authors = ["Dan Wolfson "] +readme = "README.md" + +[tool.poetry.dependencies] +python = "^3.12" +jupyter = "^1.0.0" +rich = "^13.7.1" +pyegeria = "^0.5.5.9" +unitycatalog = "^0.1.1" + + +[build-system] +requires = ["poetry-core"] +build-backend = "poetry.core.masonry.api" diff --git a/settings.gradle b/settings.gradle deleted file mode 100644 index a4db8ac..0000000 --- a/settings.gradle +++ /dev/null @@ -1,19 +0,0 @@ -/* - * SPDX-License-Identifier: Apache-2.0 - * Copyright Contributors to the ODPi Egeria project. - */ - -// Can pin plugin versions here as needed -pluginManagement { - plugins { - } -} -// TODO: Specify the name of the artifact (project name) here -rootProject.name = 'egeria-template-sample' - -// For multi modules, list each *project name* here -// include(':egeria-connector-postgres') - -// These define the project names. For now we'll keep them the same as the directory -// Not needed if the project name desired exactly matches the directory name -//project(':egeria-connector-postgres').projectDir = file('egeria-connector-postgres-directory') diff --git a/src/main/java/org/odpi/openmetadata/placeholder/Sample.java b/src/main/java/org/odpi/openmetadata/placeholder/Sample.java deleted file mode 100644 index 1be5126..0000000 --- a/src/main/java/org/odpi/openmetadata/placeholder/Sample.java +++ /dev/null @@ -1,10 +0,0 @@ -/* SPDX-License-Identifier: Apache-2.0 */ -/* Copyright Contributors to the ODPi Egeria project. */ - -package org.odpi.openmetadata.placeholder; - -/** - * TODO: Sample has no implementation - you need to replace this code - */ -public class Sample { -} diff --git a/src/test/java/org/odpi/openmetadata/placeholder/SampleTest.java b/src/test/java/org/odpi/openmetadata/placeholder/SampleTest.java deleted file mode 100644 index c42ebc1..0000000 --- a/src/test/java/org/odpi/openmetadata/placeholder/SampleTest.java +++ /dev/null @@ -1,21 +0,0 @@ -/* SPDX-License-Identifier: Apache-2.0 */ -/* Copyright Contributors to the ODPi Egeria project. */ - -// TODO: Remove placeholder test code & replace with real code -package org.odpi.openmetadata.placeholder; - -import org.junit.jupiter.api.Test; - -import static org.junit.jupiter.api.Assertions.assertTrue; - - -/** - * KafkaMonitorIntegrationConnector catalogues active topics in a Strimzi broker. - */ -public class SampleTest { - - @Test - public void testSample() { - assertTrue(true); - } -} diff --git a/workspaces/Survey & Explore.ipynb b/workspaces/Survey & Explore.ipynb new file mode 100644 index 0000000..e09b952 --- /dev/null +++ b/workspaces/Survey & Explore.ipynb @@ -0,0 +1,76 @@ +{ + "cells": [ + { + "cell_type": "code", + "execution_count": 3, + "id": "34986bff-1bd8-4a66-bf10-dd1a17042593", + "metadata": {}, + "outputs": [], + "source": [ + "from pyegeria import AutomatedCuration\n", + "import asyncio\n", + "import nest_asyncio\n", + "nest_asyncio.apply()" + ] + }, + { + "cell_type": "code", + "execution_count": 5, + "id": "5304b227-0d6e-4789-b34e-05773f771ab4", + "metadata": {}, + "outputs": [ + { + "ename": "InvalidParameterException", + "evalue": "A client-side error 400 was received by method __step from API call Client during the call https://host.docker.internal:9443/servers/active-metadata-store/open-metadata/framework-services/asset-owner/open-metadata-store/users/garygeeke/metadata-elements/by-search-string?startFrom=start_from&pageSize=page_size. The error message was CLIENT-SIDE-REST-API-CONNECTOR-503-002", + "output_type": "error", + "traceback": [ + "\u001b[0;31m---------------------------------------------------------------------------\u001b[0m", + "\u001b[0;31mInvalidParameterException\u001b[0m Traceback (most recent call last)", + "Cell \u001b[0;32mIn[5], line 3\u001b[0m\n\u001b[1;32m 1\u001b[0m p \u001b[38;5;241m=\u001b[39m LoadedResources(\u001b[38;5;124m\"\u001b[39m\u001b[38;5;124mactive-metadata-store\u001b[39m\u001b[38;5;124m\"\u001b[39m,\u001b[38;5;124m\"\u001b[39m\u001b[38;5;124mhttps://host.docker.internal:9443\u001b[39m\u001b[38;5;124m\"\u001b[39m, \u001b[38;5;124m\"\u001b[39m\u001b[38;5;124mgarygeeke\u001b[39m\u001b[38;5;124m\"\u001b[39m, \u001b[38;5;124m\"\u001b[39m\u001b[38;5;124msecret\u001b[39m\u001b[38;5;124m\"\u001b[39m)\n\u001b[1;32m 2\u001b[0m token \u001b[38;5;241m=\u001b[39m p\u001b[38;5;241m.\u001b[39mcreate_egeria_bearer_token()\n\u001b[0;32m----> 3\u001b[0m \u001b[43mp\u001b[49m\u001b[38;5;241;43m.\u001b[39;49m\u001b[43mget_all_templates\u001b[49m\u001b[43m(\u001b[49m\u001b[43m)\u001b[49m\n", + "File \u001b[0;32m/opt/conda/lib/python3.11/site-packages/pyegeria/Xloaded_resources_omvs.py:88\u001b[0m, in \u001b[0;36mLoadedResources.get_all_templates\u001b[0;34m(self, server, start_from, page_size)\u001b[0m\n\u001b[1;32m 82\u001b[0m url \u001b[38;5;241m=\u001b[39m (\u001b[38;5;124mf\u001b[39m\u001b[38;5;124m\"\u001b[39m\u001b[38;5;132;01m{\u001b[39;00m\u001b[38;5;28mself\u001b[39m\u001b[38;5;241m.\u001b[39mplatform_url\u001b[38;5;132;01m}\u001b[39;00m\u001b[38;5;124m/servers/\u001b[39m\u001b[38;5;132;01m{\u001b[39;00mserver\u001b[38;5;132;01m}\u001b[39;00m\u001b[38;5;124m/open-metadata/framework-services/asset-owner/open-metadata-store/\u001b[39m\u001b[38;5;124m\"\u001b[39m\n\u001b[1;32m 83\u001b[0m \u001b[38;5;124mf\u001b[39m\u001b[38;5;124m\"\u001b[39m\u001b[38;5;124musers/\u001b[39m\u001b[38;5;132;01m{\u001b[39;00m\u001b[38;5;28mself\u001b[39m\u001b[38;5;241m.\u001b[39muser_id\u001b[38;5;132;01m}\u001b[39;00m\u001b[38;5;124m/metadata-elements/by-search-string?startFrom=start_from&pageSize=page_size\u001b[39m\u001b[38;5;124m\"\u001b[39m)\n\u001b[1;32m 84\u001b[0m body \u001b[38;5;241m=\u001b[39m {\n\u001b[1;32m 85\u001b[0m \u001b[38;5;124m\"\u001b[39m\u001b[38;5;124mclass\u001b[39m\u001b[38;5;124m\"\u001b[39m : \u001b[38;5;124m\"\u001b[39m\u001b[38;5;124mSearchStringRequestBody\u001b[39m\u001b[38;5;124m\"\u001b[39m,\n\u001b[1;32m 86\u001b[0m \u001b[38;5;124m\"\u001b[39m\u001b[38;5;124msearchString\u001b[39m\u001b[38;5;124m\"\u001b[39m : \u001b[38;5;124m\"\u001b[39m\u001b[38;5;124m.*Template.*\u001b[39m\u001b[38;5;124m\"\u001b[39m\n\u001b[1;32m 87\u001b[0m }\n\u001b[0;32m---> 88\u001b[0m response \u001b[38;5;241m=\u001b[39m \u001b[38;5;28;43mself\u001b[39;49m\u001b[38;5;241;43m.\u001b[39;49m\u001b[43mmake_request\u001b[49m\u001b[43m(\u001b[49m\u001b[38;5;124;43m\"\u001b[39;49m\u001b[38;5;124;43mPOST\u001b[39;49m\u001b[38;5;124;43m\"\u001b[39;49m\u001b[43m,\u001b[49m\u001b[43m \u001b[49m\u001b[43murl\u001b[49m\u001b[43m,\u001b[49m\u001b[43m \u001b[49m\u001b[43mbody\u001b[49m\u001b[43m)\u001b[49m\n\u001b[1;32m 89\u001b[0m \u001b[38;5;28;01mreturn\u001b[39;00m response\u001b[38;5;241m.\u001b[39mjson()\u001b[38;5;241m.\u001b[39mget(\u001b[38;5;124m\"\u001b[39m\u001b[38;5;124melementList\u001b[39m\u001b[38;5;124m\"\u001b[39m, \u001b[38;5;124m\"\u001b[39m\u001b[38;5;124mNo elements\u001b[39m\u001b[38;5;124m\"\u001b[39m)\n", + "File \u001b[0;32m/opt/conda/lib/python3.11/site-packages/pyegeria/_client.py:338\u001b[0m, in \u001b[0;36mClient.make_request\u001b[0;34m(self, request_type, endpoint, payload, time_out)\u001b[0m\n\u001b[1;32m 336\u001b[0m \u001b[38;5;250m\u001b[39m\u001b[38;5;124;03m\"\"\" Make a request to the Egeria API\"\"\"\u001b[39;00m\n\u001b[1;32m 337\u001b[0m loop \u001b[38;5;241m=\u001b[39m asyncio\u001b[38;5;241m.\u001b[39mget_event_loop()\n\u001b[0;32m--> 338\u001b[0m response \u001b[38;5;241m=\u001b[39m \u001b[43mloop\u001b[49m\u001b[38;5;241;43m.\u001b[39;49m\u001b[43mrun_until_complete\u001b[49m\u001b[43m(\u001b[49m\u001b[38;5;28;43mself\u001b[39;49m\u001b[38;5;241;43m.\u001b[39;49m\u001b[43m_async_make_request\u001b[49m\u001b[43m(\u001b[49m\u001b[43mrequest_type\u001b[49m\u001b[43m,\u001b[49m\u001b[43m \u001b[49m\u001b[43mendpoint\u001b[49m\u001b[43m,\u001b[49m\n\u001b[1;32m 339\u001b[0m \u001b[43m \u001b[49m\u001b[43mpayload\u001b[49m\u001b[43m,\u001b[49m\u001b[43m \u001b[49m\u001b[43mtime_out\u001b[49m\u001b[43m)\u001b[49m\u001b[43m)\u001b[49m\n\u001b[1;32m 340\u001b[0m \u001b[38;5;28;01mreturn\u001b[39;00m response\n", + "File \u001b[0;32m/opt/conda/lib/python3.11/site-packages/nest_asyncio.py:98\u001b[0m, in \u001b[0;36m_patch_loop..run_until_complete\u001b[0;34m(self, future)\u001b[0m\n\u001b[1;32m 95\u001b[0m \u001b[38;5;28;01mif\u001b[39;00m \u001b[38;5;129;01mnot\u001b[39;00m f\u001b[38;5;241m.\u001b[39mdone():\n\u001b[1;32m 96\u001b[0m \u001b[38;5;28;01mraise\u001b[39;00m \u001b[38;5;167;01mRuntimeError\u001b[39;00m(\n\u001b[1;32m 97\u001b[0m \u001b[38;5;124m'\u001b[39m\u001b[38;5;124mEvent loop stopped before Future completed.\u001b[39m\u001b[38;5;124m'\u001b[39m)\n\u001b[0;32m---> 98\u001b[0m \u001b[38;5;28;01mreturn\u001b[39;00m \u001b[43mf\u001b[49m\u001b[38;5;241;43m.\u001b[39;49m\u001b[43mresult\u001b[49m\u001b[43m(\u001b[49m\u001b[43m)\u001b[49m\n", + "File \u001b[0;32m/opt/conda/lib/python3.11/asyncio/futures.py:203\u001b[0m, in \u001b[0;36mFuture.result\u001b[0;34m(self)\u001b[0m\n\u001b[1;32m 201\u001b[0m \u001b[38;5;28mself\u001b[39m\u001b[38;5;241m.\u001b[39m__log_traceback \u001b[38;5;241m=\u001b[39m \u001b[38;5;28;01mFalse\u001b[39;00m\n\u001b[1;32m 202\u001b[0m \u001b[38;5;28;01mif\u001b[39;00m \u001b[38;5;28mself\u001b[39m\u001b[38;5;241m.\u001b[39m_exception \u001b[38;5;129;01mis\u001b[39;00m \u001b[38;5;129;01mnot\u001b[39;00m \u001b[38;5;28;01mNone\u001b[39;00m:\n\u001b[0;32m--> 203\u001b[0m \u001b[38;5;28;01mraise\u001b[39;00m \u001b[38;5;28mself\u001b[39m\u001b[38;5;241m.\u001b[39m_exception\u001b[38;5;241m.\u001b[39mwith_traceback(\u001b[38;5;28mself\u001b[39m\u001b[38;5;241m.\u001b[39m_exception_tb)\n\u001b[1;32m 204\u001b[0m \u001b[38;5;28;01mreturn\u001b[39;00m \u001b[38;5;28mself\u001b[39m\u001b[38;5;241m.\u001b[39m_result\n", + "File \u001b[0;32m/opt/conda/lib/python3.11/asyncio/tasks.py:277\u001b[0m, in \u001b[0;36mTask.__step\u001b[0;34m(***failed resolving arguments***)\u001b[0m\n\u001b[1;32m 273\u001b[0m \u001b[38;5;28;01mtry\u001b[39;00m:\n\u001b[1;32m 274\u001b[0m \u001b[38;5;28;01mif\u001b[39;00m exc \u001b[38;5;129;01mis\u001b[39;00m \u001b[38;5;28;01mNone\u001b[39;00m:\n\u001b[1;32m 275\u001b[0m \u001b[38;5;66;03m# We use the `send` method directly, because coroutines\u001b[39;00m\n\u001b[1;32m 276\u001b[0m \u001b[38;5;66;03m# don't have `__iter__` and `__next__` methods.\u001b[39;00m\n\u001b[0;32m--> 277\u001b[0m result \u001b[38;5;241m=\u001b[39m coro\u001b[38;5;241m.\u001b[39msend(\u001b[38;5;28;01mNone\u001b[39;00m)\n\u001b[1;32m 278\u001b[0m \u001b[38;5;28;01melse\u001b[39;00m:\n\u001b[1;32m 279\u001b[0m result \u001b[38;5;241m=\u001b[39m coro\u001b[38;5;241m.\u001b[39mthrow(exc)\n", + "File \u001b[0;32m/opt/conda/lib/python3.11/site-packages/pyegeria/_client.py:480\u001b[0m, in \u001b[0;36mClient._async_make_request\u001b[0;34m(self, request_type, endpoint, payload, time_out)\u001b[0m\n\u001b[1;32m 478\u001b[0m \u001b[38;5;28;01mraise\u001b[39;00m UserNotAuthorizedException(exc_msg)\n\u001b[1;32m 479\u001b[0m \u001b[38;5;28;01melse\u001b[39;00m:\n\u001b[0;32m--> 480\u001b[0m \u001b[38;5;28;01mraise\u001b[39;00m InvalidParameterException(exc_msg)\n\u001b[1;32m 482\u001b[0m \u001b[38;5;28;01melif\u001b[39;00m response\u001b[38;5;241m.\u001b[39mstatus_code \u001b[38;5;129;01min\u001b[39;00m (\u001b[38;5;241m500\u001b[39m, \u001b[38;5;241m501\u001b[39m, \u001b[38;5;241m502\u001b[39m, \u001b[38;5;241m503\u001b[39m, \u001b[38;5;241m504\u001b[39m):\n\u001b[1;32m 483\u001b[0m \u001b[38;5;66;03m# server errors\u001b[39;00m\n\u001b[1;32m 484\u001b[0m msg \u001b[38;5;241m=\u001b[39m OMAGCommonErrorCode\u001b[38;5;241m.\u001b[39mEXCEPTION_RESPONSE_FROM_API\u001b[38;5;241m.\u001b[39mvalue[\n\u001b[1;32m 485\u001b[0m \u001b[38;5;124m\"\u001b[39m\u001b[38;5;124mmessage_template\u001b[39m\u001b[38;5;124m\"\u001b[39m\n\u001b[1;32m 486\u001b[0m ]\u001b[38;5;241m.\u001b[39mformat(\n\u001b[0;32m (...)\u001b[0m\n\u001b[1;32m 490\u001b[0m OMAGCommonErrorCode\u001b[38;5;241m.\u001b[39mEXCEPTION_RESPONSE_FROM_API\u001b[38;5;241m.\u001b[39mvalue[\u001b[38;5;124m\"\u001b[39m\u001b[38;5;124mmessage_id\u001b[39m\u001b[38;5;124m\"\u001b[39m],\n\u001b[1;32m 491\u001b[0m ) \u001b[38;5;241m+\u001b[39m \u001b[38;5;124m\"\u001b[39m\u001b[38;5;124m==>System reports:\u001b[39m\u001b[38;5;124m'\u001b[39m\u001b[38;5;124m\"\u001b[39m \u001b[38;5;241m+\u001b[39m response\u001b[38;5;241m.\u001b[39mreason_phrase \u001b[38;5;241m+\u001b[39m \u001b[38;5;124m\"\u001b[39m\u001b[38;5;124m'\u001b[39m\u001b[38;5;124m\"\u001b[39m\n", + "\u001b[0;31mInvalidParameterException\u001b[0m: A client-side error 400 was received by method __step from API call Client during the call https://host.docker.internal:9443/servers/active-metadata-store/open-metadata/framework-services/asset-owner/open-metadata-store/users/garygeeke/metadata-elements/by-search-string?startFrom=start_from&pageSize=page_size. The error message was CLIENT-SIDE-REST-API-CONNECTOR-503-002" + ] + } + ], + "source": [ + "p = LoadedResources(\"active-metadata-store\",\"https://host.docker.internal:9443\", \"garygeeke\", \"secret\")\n", + "token = p.create_egeria_bearer_token()\n", + "p.get_all_templates()" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "cd0e31a0-b190-46ba-be20-f647e686d6b7", + "metadata": {}, + "outputs": [], + "source": [] + } + ], + "metadata": { + "kernelspec": { + "display_name": "Python 3 (ipykernel)", + "language": "python", + "name": "python3" + }, + "language_info": { + "codemirror_mode": { + "name": "ipython", + "version": 3 + }, + "file_extension": ".py", + "mimetype": "text/x-python", + "name": "python", + "nbconvert_exporter": "python", + "pygments_lexer": "ipython3", + "version": "3.11.9" + } + }, + "nbformat": 4, + "nbformat_minor": 5 +} diff --git a/workspaces/Untitled.ipynb b/workspaces/Untitled.ipynb new file mode 100644 index 0000000..5e9f891 --- /dev/null +++ b/workspaces/Untitled.ipynb @@ -0,0 +1,97 @@ +{ + "cells": [ + { + "cell_type": "code", + "execution_count": 1, + "id": "2094e0fc-29c6-4f33-b40e-e67d4f046a5f", + "metadata": {}, + "outputs": [], + "source": [ + "from pyegeria import AutomatedCuration" + ] + }, + { + "cell_type": "code", + "execution_count": 2, + "id": "5114abc1-ef5f-49a5-a097-745b82b6cf45", + "metadata": {}, + "outputs": [], + "source": [ + "import asyncio\n", + "import nest_asyncio\n", + "nest_asyncio.apply()" + ] + }, + { + "cell_type": "code", + "execution_count": 11, + "id": "1cb9b8e5-2672-4ae1-a8a3-7ef368ef368c", + "metadata": {}, + "outputs": [], + "source": [ + "client = AutomatedCuration('view-server','https://host.docker.internal:9443','erinoverview','secret')\n", + "token = client.create_egeria_bearer_token() " + ] + }, + { + "cell_type": "code", + "execution_count": 12, + "id": "458d6da3-bfb8-4f4c-80eb-84f28505d910", + "metadata": {}, + "outputs": [], + "source": [ + "client = client.get_engine_actions()\n" + ] + }, + { + "cell_type": "code", + "execution_count": 13, + "id": "0b614b04-fe66-4f85-b027-57625a0c9127", + "metadata": {}, + "outputs": [ + { + "data": { + "text/plain": [ + "'No elements'" + ] + }, + "execution_count": 13, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "client" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "id": "3fffc1c3-ee0a-4b4f-8bf1-b3b67cc41158", + "metadata": {}, + "outputs": [], + "source": [] + } + ], + "metadata": { + "kernelspec": { + "display_name": "Python 3 (ipykernel)", + "language": "python", + "name": "python3" + }, + "language_info": { + "codemirror_mode": { + "name": "ipython", + "version": 3 + }, + "file_extension": ".py", + "mimetype": "text/x-python", + "name": "python", + "nbconvert_exporter": "python", + "pygments_lexer": "ipython3", + "version": "3.11.9" + } + }, + "nbformat": 4, + "nbformat_minor": 5 +} diff --git a/workspaces/experiments.ipynb b/workspaces/experiments.ipynb new file mode 100644 index 0000000..ce91dcc --- /dev/null +++ b/workspaces/experiments.ipynb @@ -0,0 +1,734 @@ +{ + "cells": [ + { + "cell_type": "code", + "execution_count": 1, + "id": "9968014f-4cd4-40fb-959a-13689f5ac01e", + "metadata": { + "ExecuteTime": { + "end_time": "2024-07-18T00:23:20.558488Z", + "start_time": "2024-07-18T00:23:20.551811Z" + }, + "editable": true, + "slideshow": { + "slide_type": "" + }, + "tags": [] + }, + "outputs": [], + "source": [ + "import asyncio\n", + "import nest_asyncio\n", + "nest_asyncio.apply()" + ] + }, + { + "cell_type": "code", + "execution_count": 2, + "id": "a11585d4-48e0-43c8-aba9-0bbc1b1cbbc1", + "metadata": { + "ExecuteTime": { + "end_time": "2024-07-18T00:23:22.658459Z", + "start_time": "2024-07-18T00:23:22.484398Z" + } + }, + "outputs": [], + "source": [ + "from pyegeria import Platform\n" + ] + }, + { + "cell_type": "code", + "execution_count": 3, + "id": "271affe2-3f66-46cf-b3ec-75fe4e3d2cfe", + "metadata": { + "ExecuteTime": { + "end_time": "2024-07-18T00:23:24.245215Z", + "start_time": "2024-07-18T00:23:24.202681Z" + } + }, + "outputs": [ + { + "data": { + "text/plain": [ + "'Egeria OMAG Server Platform (version 5.1-SNAPSHOT)\\n'" + ] + }, + "execution_count": 3, + "metadata": {}, + "output_type": "execute_result" + } + ], + "source": [ + "p_client = Platform('active-metadata-store', \"https://host.docker.internal:9443\",\"garygeeke\")\n", + "p_client.get_platform_origin() " + ] + }, + { + "cell_type": "code", + "execution_count": 5, + "id": "802fe1f8-9bd5-4378-ae46-2a677a8466b7", + "metadata": { + "ExecuteTime": { + "end_time": "2024-07-18T00:27:13.308981Z", + "start_time": "2024-07-18T00:27:10.147943Z" + }, + "editable": true, + "slideshow": { + "slide_type": "" + }, + "tags": [] + }, + "outputs": [ + { + "data": { + "text/html": [ + "
\n"
+      ],
+      "text/plain": []
+     },
+     "metadata": {},
+     "output_type": "display_data"
+    },
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "\n"
+     ]
+    },
+    {
+     "data": {
+      "text/html": [
+       "
╭─────────────────────────────── Traceback (most recent call last) ────────────────────────────────╮\n",
+       "│ /opt/conda/lib/python3.11/site-packages/httpx/_transports/default.py:69 in                       │\n",
+       "│ map_httpcore_exceptions                                                                          │\n",
+       "│                                                                                                  │\n",
+       "│    66 @contextlib.contextmanager                                                                 │\n",
+       "│    67 def map_httpcore_exceptions() -> typing.Iterator[None]:                                    │\n",
+       "│    68 │   try:                                                                                   │\n",
+       "│ ❱  69 │   │   yield                                                                              │\n",
+       "│    70 │   except Exception as exc:                                                               │\n",
+       "│    71 │   │   mapped_exc = None                                                                  │\n",
+       "│    72                                                                                            │\n",
+       "│                                                                                                  │\n",
+       "│ /opt/conda/lib/python3.11/site-packages/httpx/_transports/default.py:233 in handle_request       │\n",
+       "│                                                                                                  │\n",
+       "│   230 │   │   │   extensions=request.extensions,                                                 │\n",
+       "│   231 │   │   )                                                                                  │\n",
+       "│   232 │   │   with map_httpcore_exceptions():                                                    │\n",
+       "│ ❱ 233 │   │   │   resp = self._pool.handle_request(req)                                          │\n",
+       "│   234 │   │                                                                                      │\n",
+       "│   235 │   │   assert isinstance(resp.stream, typing.Iterable)                                    │\n",
+       "│   236                                                                                            │\n",
+       "│                                                                                                  │\n",
+       "│ /opt/conda/lib/python3.11/site-packages/httpcore/_sync/connection_pool.py:216 in handle_request  │\n",
+       "│                                                                                                  │\n",
+       "│   213 │   │   │   │   closing = self._assign_requests_to_connections()                           │\n",
+       "│   214 │   │   │                                                                                  │\n",
+       "│   215 │   │   │   self._close_connections(closing)                                               │\n",
+       "│ ❱ 216 │   │   │   raise exc from None                                                            │\n",
+       "│   217 │   │                                                                                      │\n",
+       "│   218 │   │   # Return the response. Note that in this case we still have to manage              │\n",
+       "│   219 │   │   # the point at which the response is closed.                                       │\n",
+       "│                                                                                                  │\n",
+       "│ /opt/conda/lib/python3.11/site-packages/httpcore/_sync/connection_pool.py:196 in handle_request  │\n",
+       "│                                                                                                  │\n",
+       "│   193 │   │   │   │                                                                              │\n",
+       "│   194 │   │   │   │   try:                                                                       │\n",
+       "│   195 │   │   │   │   │   # Send the request on the assigned connection.                         │\n",
+       "│ ❱ 196 │   │   │   │   │   response = connection.handle_request(                                  │\n",
+       "│   197 │   │   │   │   │   │   pool_request.request                                               │\n",
+       "│   198 │   │   │   │   │   )                                                                      │\n",
+       "│   199 │   │   │   │   except ConnectionNotAvailable:                                             │\n",
+       "│                                                                                                  │\n",
+       "│ /opt/conda/lib/python3.11/site-packages/httpcore/_sync/connection.py:99 in handle_request        │\n",
+       "│                                                                                                  │\n",
+       "│    96 │   │   │   │   │   │   )                                                                  │\n",
+       "│    97 │   │   except BaseException as exc:                                                       │\n",
+       "│    98 │   │   │   self._connect_failed = True                                                    │\n",
+       "│ ❱  99 │   │   │   raise exc                                                                      │\n",
+       "│   100 │   │                                                                                      │\n",
+       "│   101 │   │   return self._connection.handle_request(request)                                    │\n",
+       "│   102                                                                                            │\n",
+       "│                                                                                                  │\n",
+       "│ /opt/conda/lib/python3.11/site-packages/httpcore/_sync/connection.py:76 in handle_request        │\n",
+       "│                                                                                                  │\n",
+       "│    73 │   │   try:                                                                               │\n",
+       "│    74 │   │   │   with self._request_lock:                                                       │\n",
+       "│    75 │   │   │   │   if self._connection is None:                                               │\n",
+       "│ ❱  76 │   │   │   │   │   stream = self._connect(request)                                        │\n",
+       "│    77 │   │   │   │   │                                                                          │\n",
+       "│    78 │   │   │   │   │   ssl_object = stream.get_extra_info(\"ssl_object\")                       │\n",
+       "│    79 │   │   │   │   │   http2_negotiated = (                                                   │\n",
+       "│                                                                                                  │\n",
+       "│ /opt/conda/lib/python3.11/site-packages/httpcore/_sync/connection.py:122 in _connect             │\n",
+       "│                                                                                                  │\n",
+       "│   119 │   │   │   │   │   │   \"socket_options\": self._socket_options,                            │\n",
+       "│   120 │   │   │   │   │   }                                                                      │\n",
+       "│   121 │   │   │   │   │   with Trace(\"connect_tcp\", logger, request, kwargs) as trace:           │\n",
+       "│ ❱ 122 │   │   │   │   │   │   stream = self._network_backend.connect_tcp(**kwargs)               │\n",
+       "│   123 │   │   │   │   │   │   trace.return_value = stream                                        │\n",
+       "│   124 │   │   │   │   else:                                                                      │\n",
+       "│   125 │   │   │   │   │   kwargs = {                                                             │\n",
+       "│                                                                                                  │\n",
+       "│ /opt/conda/lib/python3.11/site-packages/httpcore/_backends/sync.py:205 in connect_tcp            │\n",
+       "│                                                                                                  │\n",
+       "│   202 │   │   │   OSError: ConnectError,                                                         │\n",
+       "│   203 │   │   }                                                                                  │\n",
+       "│   204 │   │                                                                                      │\n",
+       "│ ❱ 205 │   │   with map_exceptions(exc_map):                                                      │\n",
+       "│   206 │   │   │   sock = socket.create_connection(                                               │\n",
+       "│   207 │   │   │   │   address,                                                                   │\n",
+       "│   208 │   │   │   │   timeout,                                                                   │\n",
+       "│                                                                                                  │\n",
+       "│ /opt/conda/lib/python3.11/contextlib.py:158 in __exit__                                          │\n",
+       "│                                                                                                  │\n",
+       "│   155 │   │   │   │   # tell if we get the same exception back                                   │\n",
+       "│   156 │   │   │   │   value = typ()                                                              │\n",
+       "│   157 │   │   │   try:                                                                           │\n",
+       "│ ❱ 158 │   │   │   │   self.gen.throw(typ, value, traceback)                                      │\n",
+       "│   159 │   │   │   except StopIteration as exc:                                                   │\n",
+       "│   160 │   │   │   │   # Suppress StopIteration *unless* it's the same exception that             │\n",
+       "│   161 │   │   │   │   # was passed to throw().  This prevents a StopIteration                    │\n",
+       "│                                                                                                  │\n",
+       "│ /opt/conda/lib/python3.11/site-packages/httpcore/_exceptions.py:14 in map_exceptions             │\n",
+       "│                                                                                                  │\n",
+       "│   11 │   except Exception as exc:  # noqa: PIE786                                                │\n",
+       "│   12 │   │   for from_exc, to_exc in map.items():                                                │\n",
+       "│   13 │   │   │   if isinstance(exc, from_exc):                                                   │\n",
+       "│ ❱ 14 │   │   │   │   raise to_exc(exc) from exc                                                  │\n",
+       "│   15 │   │   raise  # pragma: nocover                                                            │\n",
+       "│   16                                                                                             │\n",
+       "│   17                                                                                             │\n",
+       "╰──────────────────────────────────────────────────────────────────────────────────────────────────╯\n",
+       "ConnectError: [Errno 111] Connection refused\n",
+       "\n",
+       "The above exception was the direct cause of the following exception:\n",
+       "\n",
+       "╭─────────────────────────────── Traceback (most recent call last) ────────────────────────────────╮\n",
+       "│ /opt/conda/lib/python3.11/site-packages/unitycatalog/_base_client.py:951 in _request             │\n",
+       "│                                                                                                  │\n",
+       "│    948 │   │   log.debug(\"Sending HTTP Request: %s %s\", request.method, request.url)             │\n",
+       "│    949 │   │                                                                                     │\n",
+       "│    950 │   │   try:                                                                              │\n",
+       "│ ❱  951 │   │   │   response = self._client.send(                                                 │\n",
+       "│    952 │   │   │   │   request,                                                                  │\n",
+       "│    953 │   │   │   │   stream=stream or self._should_stream_response_body(request=request),      │\n",
+       "│    954 │   │   │   │   **kwargs,                                                                 │\n",
+       "│                                                                                                  │\n",
+       "│ /opt/conda/lib/python3.11/site-packages/httpx/_client.py:914 in send                             │\n",
+       "│                                                                                                  │\n",
+       "│    911 │   │                                                                                     │\n",
+       "│    912 │   │   auth = self._build_request_auth(request, auth)                                    │\n",
+       "│    913 │   │                                                                                     │\n",
+       "│ ❱  914 │   │   response = self._send_handling_auth(                                              │\n",
+       "│    915 │   │   │   request,                                                                      │\n",
+       "│    916 │   │   │   auth=auth,                                                                    │\n",
+       "│    917 │   │   │   follow_redirects=follow_redirects,                                            │\n",
+       "│                                                                                                  │\n",
+       "│ /opt/conda/lib/python3.11/site-packages/httpx/_client.py:942 in _send_handling_auth              │\n",
+       "│                                                                                                  │\n",
+       "│    939 │   │   │   request = next(auth_flow)                                                     │\n",
+       "│    940 │   │   │                                                                                 │\n",
+       "│    941 │   │   │   while True:                                                                   │\n",
+       "│ ❱  942 │   │   │   │   response = self._send_handling_redirects(                                 │\n",
+       "│    943 │   │   │   │   │   request,                                                              │\n",
+       "│    944 │   │   │   │   │   follow_redirects=follow_redirects,                                    │\n",
+       "│    945 │   │   │   │   │   history=history,                                                      │\n",
+       "│                                                                                                  │\n",
+       "│ /opt/conda/lib/python3.11/site-packages/httpx/_client.py:979 in _send_handling_redirects         │\n",
+       "│                                                                                                  │\n",
+       "│    976 │   │   │   for hook in self._event_hooks[\"request\"]:                                     │\n",
+       "│    977 │   │   │   │   hook(request)                                                             │\n",
+       "│    978 │   │   │                                                                                 │\n",
+       "│ ❱  979 │   │   │   response = self._send_single_request(request)                                 │\n",
+       "│    980 │   │   │   try:                                                                          │\n",
+       "│    981 │   │   │   │   for hook in self._event_hooks[\"response\"]:                                │\n",
+       "│    982 │   │   │   │   │   hook(response)                                                        │\n",
+       "│                                                                                                  │\n",
+       "│ /opt/conda/lib/python3.11/site-packages/httpx/_client.py:1015 in _send_single_request            │\n",
+       "│                                                                                                  │\n",
+       "│   1012 │   │   │   )                                                                             │\n",
+       "│   1013 │   │                                                                                     │\n",
+       "│   1014 │   │   with request_context(request=request):                                            │\n",
+       "│ ❱ 1015 │   │   │   response = transport.handle_request(request)                                  │\n",
+       "│   1016 │   │                                                                                     │\n",
+       "│   1017 │   │   assert isinstance(response.stream, SyncByteStream)                                │\n",
+       "│   1018                                                                                           │\n",
+       "│                                                                                                  │\n",
+       "│ /opt/conda/lib/python3.11/site-packages/httpx/_transports/default.py:232 in handle_request       │\n",
+       "│                                                                                                  │\n",
+       "│   229 │   │   │   content=request.stream,                                                        │\n",
+       "│   230 │   │   │   extensions=request.extensions,                                                 │\n",
+       "│   231 │   │   )                                                                                  │\n",
+       "│ ❱ 232 │   │   with map_httpcore_exceptions():                                                    │\n",
+       "│   233 │   │   │   resp = self._pool.handle_request(req)                                          │\n",
+       "│   234 │   │                                                                                      │\n",
+       "│   235 │   │   assert isinstance(resp.stream, typing.Iterable)                                    │\n",
+       "│                                                                                                  │\n",
+       "│ /opt/conda/lib/python3.11/contextlib.py:158 in __exit__                                          │\n",
+       "│                                                                                                  │\n",
+       "│   155 │   │   │   │   # tell if we get the same exception back                                   │\n",
+       "│   156 │   │   │   │   value = typ()                                                              │\n",
+       "│   157 │   │   │   try:                                                                           │\n",
+       "│ ❱ 158 │   │   │   │   self.gen.throw(typ, value, traceback)                                      │\n",
+       "│   159 │   │   │   except StopIteration as exc:                                                   │\n",
+       "│   160 │   │   │   │   # Suppress StopIteration *unless* it's the same exception that             │\n",
+       "│   161 │   │   │   │   # was passed to throw().  This prevents a StopIteration                    │\n",
+       "│                                                                                                  │\n",
+       "│ /opt/conda/lib/python3.11/site-packages/httpx/_transports/default.py:86 in                       │\n",
+       "│ map_httpcore_exceptions                                                                          │\n",
+       "│                                                                                                  │\n",
+       "│    83 │   │   │   raise                                                                          │\n",
+       "│    84 │   │                                                                                      │\n",
+       "│    85 │   │   message = str(exc)                                                                 │\n",
+       "│ ❱  86 │   │   raise mapped_exc(message) from exc                                                 │\n",
+       "│    87                                                                                            │\n",
+       "│    88                                                                                            │\n",
+       "│    89 HTTPCORE_EXC_MAP = {                                                                       │\n",
+       "╰──────────────────────────────────────────────────────────────────────────────────────────────────╯\n",
+       "ConnectError: [Errno 111] Connection refused\n",
+       "\n",
+       "The above exception was the direct cause of the following exception:\n",
+       "\n",
+       "╭─────────────────────────────── Traceback (most recent call last) ────────────────────────────────╮\n",
+       "│ /home/jovyan/workspaces/uc_oss_catalog_viewer.py:147 in display_catalog                          │\n",
+       "│                                                                                                  │\n",
+       "│   144 │   try:                                                                                   │\n",
+       "│   145 │   │   console = Console(width=200)                                                       │\n",
+       "│   146 │   │   with console.pager():                                                              │\n",
+       "│ ❱ 147 │   │   │   console.print(generate_table())                                                │\n",
+       "│   148 │                                                                                          │\n",
+       "│   149 │   except Exception as e:                                                                 │\n",
+       "│   150 │   │   print()                                                                            │\n",
+       "│                                                                                                  │\n",
+       "│ /home/jovyan/workspaces/uc_oss_catalog_viewer.py:49 in generate_table                            │\n",
+       "│                                                                                                  │\n",
+       "│    46 │   │   table.add_column(\"Vol/Tab\")                                                        │\n",
+       "│    47 │   │   table.add_column(\"Details\")                                                        │\n",
+       "│    48 │   │                                                                                      │\n",
+       "│ ❱  49 │   │   c_list = uc_client.catalogs.list()                                                 │\n",
+       "│    50 │   │   catalogs= c_list.catalogs                                                          │\n",
+       "│    51 │   │   for catalog in catalogs:                                                           │\n",
+       "│    52 │   │   │   # cat_info = catalog.CatalogInfo                                               │\n",
+       "│                                                                                                  │\n",
+       "│ /opt/conda/lib/python3.11/site-packages/unitycatalog/resources/catalogs.py:211 in list           │\n",
+       "│                                                                                                  │\n",
+       "│   208 │   │                                                                                      │\n",
+       "│   209 │   │     timeout: Override the client-level default timeout for this request, in second   │\n",
+       "│   210 │   │   \"\"\"                                                                                │\n",
+       "│ ❱ 211 │   │   return self._get(                                                                  │\n",
+       "│   212 │   │   │   \"/catalogs\",                                                                   │\n",
+       "│   213 │   │   │   options=make_request_options(                                                  │\n",
+       "│   214 │   │   │   │   extra_headers=extra_headers,                                               │\n",
+       "│                                                                                                  │\n",
+       "│ /opt/conda/lib/python3.11/site-packages/unitycatalog/_base_client.py:1168 in get                 │\n",
+       "│                                                                                                  │\n",
+       "│   1165 │   │   opts = FinalRequestOptions.construct(method=\"get\", url=path, **options)           │\n",
+       "│   1166 │   │   # cast is required because mypy complains about returning Any even though         │\n",
+       "│   1167 │   │   # it understands the type variables                                               │\n",
+       "│ ❱ 1168 │   │   return cast(ResponseT, self.request(cast_to, opts, stream=stream, stream_cls=str  │\n",
+       "│   1169 │                                                                                         │\n",
+       "│   1170 │   @overload                                                                             │\n",
+       "│   1171 │   def post(                                                                             │\n",
+       "│                                                                                                  │\n",
+       "│ /opt/conda/lib/python3.11/site-packages/unitycatalog/_base_client.py:920 in request              │\n",
+       "│                                                                                                  │\n",
+       "│    917 │   │   stream: bool = False,                                                             │\n",
+       "│    918 │   │   stream_cls: type[_StreamT] | None = None,                                         │\n",
+       "│    919 │   ) -> ResponseT | _StreamT:                                                            │\n",
+       "│ ❱  920 │   │   return self._request(                                                             │\n",
+       "│    921 │   │   │   cast_to=cast_to,                                                              │\n",
+       "│    922 │   │   │   options=options,                                                              │\n",
+       "│    923 │   │   │   stream=stream,                                                                │\n",
+       "│                                                                                                  │\n",
+       "│ /opt/conda/lib/python3.11/site-packages/unitycatalog/_base_client.py:975 in _request             │\n",
+       "│                                                                                                  │\n",
+       "│    972 │   │   │   log.debug(\"Encountered Exception\", exc_info=True)                             │\n",
+       "│    973 │   │   │                                                                                 │\n",
+       "│    974 │   │   │   if retries > 0:                                                               │\n",
+       "│ ❱  975 │   │   │   │   return self._retry_request(                                               │\n",
+       "│    976 │   │   │   │   │   options,                                                              │\n",
+       "│    977 │   │   │   │   │   cast_to,                                                              │\n",
+       "│    978 │   │   │   │   │   retries,                                                              │\n",
+       "│                                                                                                  │\n",
+       "│ /opt/conda/lib/python3.11/site-packages/unitycatalog/_base_client.py:1051 in _retry_request      │\n",
+       "│                                                                                                  │\n",
+       "│   1048 │   │   # different thread if necessary.                                                  │\n",
+       "│   1049 │   │   time.sleep(timeout)                                                               │\n",
+       "│   1050 │   │                                                                                     │\n",
+       "│ ❱ 1051 │   │   return self._request(                                                             │\n",
+       "│   1052 │   │   │   options=options,                                                              │\n",
+       "│   1053 │   │   │   cast_to=cast_to,                                                              │\n",
+       "│   1054 │   │   │   remaining_retries=remaining,                                                  │\n",
+       "│                                                                                                  │\n",
+       "│ /opt/conda/lib/python3.11/site-packages/unitycatalog/_base_client.py:975 in _request             │\n",
+       "│                                                                                                  │\n",
+       "│    972 │   │   │   log.debug(\"Encountered Exception\", exc_info=True)                             │\n",
+       "│    973 │   │   │                                                                                 │\n",
+       "│    974 │   │   │   if retries > 0:                                                               │\n",
+       "│ ❱  975 │   │   │   │   return self._retry_request(                                               │\n",
+       "│    976 │   │   │   │   │   options,                                                              │\n",
+       "│    977 │   │   │   │   │   cast_to,                                                              │\n",
+       "│    978 │   │   │   │   │   retries,                                                              │\n",
+       "│                                                                                                  │\n",
+       "│ /opt/conda/lib/python3.11/site-packages/unitycatalog/_base_client.py:1051 in _retry_request      │\n",
+       "│                                                                                                  │\n",
+       "│   1048 │   │   # different thread if necessary.                                                  │\n",
+       "│   1049 │   │   time.sleep(timeout)                                                               │\n",
+       "│   1050 │   │                                                                                     │\n",
+       "│ ❱ 1051 │   │   return self._request(                                                             │\n",
+       "│   1052 │   │   │   options=options,                                                              │\n",
+       "│   1053 │   │   │   cast_to=cast_to,                                                              │\n",
+       "│   1054 │   │   │   remaining_retries=remaining,                                                  │\n",
+       "│                                                                                                  │\n",
+       "│ /opt/conda/lib/python3.11/site-packages/unitycatalog/_base_client.py:985 in _request             │\n",
+       "│                                                                                                  │\n",
+       "│    982 │   │   │   │   )                                                                         │\n",
+       "│    983 │   │   │                                                                                 │\n",
+       "│    984 │   │   │   log.debug(\"Raising connection error\")                                         │\n",
+       "│ ❱  985 │   │   │   raise APIConnectionError(request=request) from err                            │\n",
+       "│    986 │   │                                                                                     │\n",
+       "│    987 │   │   log.debug(                                                                        │\n",
+       "│    988 │   │   │   'HTTP Response: %s %s \"%i %s\" %s',                                            │\n",
+       "╰──────────────────────────────────────────────────────────────────────────────────────────────────╯\n",
+       "APIConnectionError: Connection error.\n",
+       "
\n"
+      ],
+      "text/plain": [
+       "\u001b[31m╭─\u001b[0m\u001b[31m──────────────────────────────\u001b[0m\u001b[31m \u001b[0m\u001b[1;31mTraceback \u001b[0m\u001b[1;2;31m(most recent call last)\u001b[0m\u001b[31m \u001b[0m\u001b[31m───────────────────────────────\u001b[0m\u001b[31m─╮\u001b[0m\n",
+       "\u001b[31m│\u001b[0m \u001b[2;33m/opt/conda/lib/python3.11/site-packages/httpx/_transports/\u001b[0m\u001b[1;33mdefault.py\u001b[0m:\u001b[94m69\u001b[0m in                       \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m \u001b[92mmap_httpcore_exceptions\u001b[0m                                                                          \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m                                                                                                  \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m 66 \u001b[0m\u001b[1;95m@contextlib\u001b[0m.contextmanager                                                                 \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m 67 \u001b[0m\u001b[94mdef\u001b[0m \u001b[92mmap_httpcore_exceptions\u001b[0m() -> typing.Iterator[\u001b[94mNone\u001b[0m]:                                    \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m 68 \u001b[0m\u001b[2m│   \u001b[0m\u001b[94mtry\u001b[0m:                                                                                   \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m \u001b[31m❱ \u001b[0m 69 \u001b[2m│   │   \u001b[0m\u001b[94myield\u001b[0m                                                                              \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m 70 \u001b[0m\u001b[2m│   \u001b[0m\u001b[94mexcept\u001b[0m \u001b[96mException\u001b[0m \u001b[94mas\u001b[0m exc:                                                               \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m 71 \u001b[0m\u001b[2m│   │   \u001b[0mmapped_exc = \u001b[94mNone\u001b[0m                                                                  \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m 72 \u001b[0m                                                                                           \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m                                                                                                  \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m \u001b[2;33m/opt/conda/lib/python3.11/site-packages/httpx/_transports/\u001b[0m\u001b[1;33mdefault.py\u001b[0m:\u001b[94m233\u001b[0m in \u001b[92mhandle_request\u001b[0m       \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m                                                                                                  \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m230 \u001b[0m\u001b[2m│   │   │   \u001b[0mextensions=request.extensions,                                                 \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m231 \u001b[0m\u001b[2m│   │   \u001b[0m)                                                                                  \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m232 \u001b[0m\u001b[2m│   │   \u001b[0m\u001b[94mwith\u001b[0m map_httpcore_exceptions():                                                    \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m \u001b[31m❱ \u001b[0m233 \u001b[2m│   │   │   \u001b[0mresp = \u001b[96mself\u001b[0m._pool.handle_request(req)                                          \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m234 \u001b[0m\u001b[2m│   │   \u001b[0m                                                                                   \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m235 \u001b[0m\u001b[2m│   │   \u001b[0m\u001b[94massert\u001b[0m \u001b[96misinstance\u001b[0m(resp.stream, typing.Iterable)                                    \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m236 \u001b[0m                                                                                           \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m                                                                                                  \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m \u001b[2;33m/opt/conda/lib/python3.11/site-packages/httpcore/_sync/\u001b[0m\u001b[1;33mconnection_pool.py\u001b[0m:\u001b[94m216\u001b[0m in \u001b[92mhandle_request\u001b[0m  \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m                                                                                                  \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m213 \u001b[0m\u001b[2m│   │   │   │   \u001b[0mclosing = \u001b[96mself\u001b[0m._assign_requests_to_connections()                           \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m214 \u001b[0m\u001b[2m│   │   │   \u001b[0m                                                                               \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m215 \u001b[0m\u001b[2m│   │   │   \u001b[0m\u001b[96mself\u001b[0m._close_connections(closing)                                               \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m \u001b[31m❱ \u001b[0m216 \u001b[2m│   │   │   \u001b[0m\u001b[94mraise\u001b[0m exc \u001b[94mfrom\u001b[0m \u001b[94mNone\u001b[0m                                                            \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m217 \u001b[0m\u001b[2m│   │   \u001b[0m                                                                                   \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m218 \u001b[0m\u001b[2m│   │   \u001b[0m\u001b[2m# Return the response. Note that in this case we still have to manage\u001b[0m              \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m219 \u001b[0m\u001b[2m│   │   \u001b[0m\u001b[2m# the point at which the response is closed.\u001b[0m                                       \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m                                                                                                  \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m \u001b[2;33m/opt/conda/lib/python3.11/site-packages/httpcore/_sync/\u001b[0m\u001b[1;33mconnection_pool.py\u001b[0m:\u001b[94m196\u001b[0m in \u001b[92mhandle_request\u001b[0m  \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m                                                                                                  \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m193 \u001b[0m\u001b[2m│   │   │   │   \u001b[0m                                                                           \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m194 \u001b[0m\u001b[2m│   │   │   │   \u001b[0m\u001b[94mtry\u001b[0m:                                                                       \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m195 \u001b[0m\u001b[2m│   │   │   │   │   \u001b[0m\u001b[2m# Send the request on the assigned connection.\u001b[0m                         \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m \u001b[31m❱ \u001b[0m196 \u001b[2m│   │   │   │   │   \u001b[0mresponse = connection.handle_request(                                  \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m197 \u001b[0m\u001b[2m│   │   │   │   │   │   \u001b[0mpool_request.request                                               \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m198 \u001b[0m\u001b[2m│   │   │   │   │   \u001b[0m)                                                                      \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m199 \u001b[0m\u001b[2m│   │   │   │   \u001b[0m\u001b[94mexcept\u001b[0m ConnectionNotAvailable:                                             \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m                                                                                                  \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m \u001b[2;33m/opt/conda/lib/python3.11/site-packages/httpcore/_sync/\u001b[0m\u001b[1;33mconnection.py\u001b[0m:\u001b[94m99\u001b[0m in \u001b[92mhandle_request\u001b[0m        \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m                                                                                                  \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m 96 \u001b[0m\u001b[2m│   │   │   │   │   │   \u001b[0m)                                                                  \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m 97 \u001b[0m\u001b[2m│   │   \u001b[0m\u001b[94mexcept\u001b[0m \u001b[96mBaseException\u001b[0m \u001b[94mas\u001b[0m exc:                                                       \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m 98 \u001b[0m\u001b[2m│   │   │   \u001b[0m\u001b[96mself\u001b[0m._connect_failed = \u001b[94mTrue\u001b[0m                                                    \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m \u001b[31m❱ \u001b[0m 99 \u001b[2m│   │   │   \u001b[0m\u001b[94mraise\u001b[0m exc                                                                      \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m100 \u001b[0m\u001b[2m│   │   \u001b[0m                                                                                   \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m101 \u001b[0m\u001b[2m│   │   \u001b[0m\u001b[94mreturn\u001b[0m \u001b[96mself\u001b[0m._connection.handle_request(request)                                    \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m102 \u001b[0m                                                                                           \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m                                                                                                  \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m \u001b[2;33m/opt/conda/lib/python3.11/site-packages/httpcore/_sync/\u001b[0m\u001b[1;33mconnection.py\u001b[0m:\u001b[94m76\u001b[0m in \u001b[92mhandle_request\u001b[0m        \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m                                                                                                  \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m 73 \u001b[0m\u001b[2m│   │   \u001b[0m\u001b[94mtry\u001b[0m:                                                                               \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m 74 \u001b[0m\u001b[2m│   │   │   \u001b[0m\u001b[94mwith\u001b[0m \u001b[96mself\u001b[0m._request_lock:                                                       \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m 75 \u001b[0m\u001b[2m│   │   │   │   \u001b[0m\u001b[94mif\u001b[0m \u001b[96mself\u001b[0m._connection \u001b[95mis\u001b[0m \u001b[94mNone\u001b[0m:                                               \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m \u001b[31m❱ \u001b[0m 76 \u001b[2m│   │   │   │   │   \u001b[0mstream = \u001b[96mself\u001b[0m._connect(request)                                        \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m 77 \u001b[0m\u001b[2m│   │   │   │   │   \u001b[0m                                                                       \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m 78 \u001b[0m\u001b[2m│   │   │   │   │   \u001b[0mssl_object = stream.get_extra_info(\u001b[33m\"\u001b[0m\u001b[33mssl_object\u001b[0m\u001b[33m\"\u001b[0m)                       \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m 79 \u001b[0m\u001b[2m│   │   │   │   │   \u001b[0mhttp2_negotiated = (                                                   \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m                                                                                                  \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m \u001b[2;33m/opt/conda/lib/python3.11/site-packages/httpcore/_sync/\u001b[0m\u001b[1;33mconnection.py\u001b[0m:\u001b[94m122\u001b[0m in \u001b[92m_connect\u001b[0m             \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m                                                                                                  \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m119 \u001b[0m\u001b[2m│   │   │   │   │   │   \u001b[0m\u001b[33m\"\u001b[0m\u001b[33msocket_options\u001b[0m\u001b[33m\"\u001b[0m: \u001b[96mself\u001b[0m._socket_options,                            \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m120 \u001b[0m\u001b[2m│   │   │   │   │   \u001b[0m}                                                                      \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m121 \u001b[0m\u001b[2m│   │   │   │   │   \u001b[0m\u001b[94mwith\u001b[0m Trace(\u001b[33m\"\u001b[0m\u001b[33mconnect_tcp\u001b[0m\u001b[33m\"\u001b[0m, logger, request, kwargs) \u001b[94mas\u001b[0m trace:           \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m \u001b[31m❱ \u001b[0m122 \u001b[2m│   │   │   │   │   │   \u001b[0mstream = \u001b[96mself\u001b[0m._network_backend.connect_tcp(**kwargs)               \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m123 \u001b[0m\u001b[2m│   │   │   │   │   │   \u001b[0mtrace.return_value = stream                                        \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m124 \u001b[0m\u001b[2m│   │   │   │   \u001b[0m\u001b[94melse\u001b[0m:                                                                      \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m125 \u001b[0m\u001b[2m│   │   │   │   │   \u001b[0mkwargs = {                                                             \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m                                                                                                  \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m \u001b[2;33m/opt/conda/lib/python3.11/site-packages/httpcore/_backends/\u001b[0m\u001b[1;33msync.py\u001b[0m:\u001b[94m205\u001b[0m in \u001b[92mconnect_tcp\u001b[0m            \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m                                                                                                  \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m202 \u001b[0m\u001b[2m│   │   │   \u001b[0m\u001b[96mOSError\u001b[0m: ConnectError,                                                         \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m203 \u001b[0m\u001b[2m│   │   \u001b[0m}                                                                                  \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m204 \u001b[0m\u001b[2m│   │   \u001b[0m                                                                                   \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m \u001b[31m❱ \u001b[0m205 \u001b[2m│   │   \u001b[0m\u001b[94mwith\u001b[0m map_exceptions(exc_map):                                                      \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m206 \u001b[0m\u001b[2m│   │   │   \u001b[0msock = socket.create_connection(                                               \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m207 \u001b[0m\u001b[2m│   │   │   │   \u001b[0maddress,                                                                   \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m208 \u001b[0m\u001b[2m│   │   │   │   \u001b[0mtimeout,                                                                   \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m                                                                                                  \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m \u001b[2;33m/opt/conda/lib/python3.11/\u001b[0m\u001b[1;33mcontextlib.py\u001b[0m:\u001b[94m158\u001b[0m in \u001b[92m__exit__\u001b[0m                                          \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m                                                                                                  \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m155 \u001b[0m\u001b[2m│   │   │   │   \u001b[0m\u001b[2m# tell if we get the same exception back\u001b[0m                                   \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m156 \u001b[0m\u001b[2m│   │   │   │   \u001b[0mvalue = typ()                                                              \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m157 \u001b[0m\u001b[2m│   │   │   \u001b[0m\u001b[94mtry\u001b[0m:                                                                           \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m \u001b[31m❱ \u001b[0m158 \u001b[2m│   │   │   │   \u001b[0m\u001b[96mself\u001b[0m.gen.throw(typ, value, traceback)                                      \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m159 \u001b[0m\u001b[2m│   │   │   \u001b[0m\u001b[94mexcept\u001b[0m \u001b[96mStopIteration\u001b[0m \u001b[94mas\u001b[0m exc:                                                   \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m160 \u001b[0m\u001b[2m│   │   │   │   \u001b[0m\u001b[2m# Suppress StopIteration *unless* it's the same exception that\u001b[0m             \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m161 \u001b[0m\u001b[2m│   │   │   │   \u001b[0m\u001b[2m# was passed to throw().  This prevents a StopIteration\u001b[0m                    \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m                                                                                                  \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m \u001b[2;33m/opt/conda/lib/python3.11/site-packages/httpcore/\u001b[0m\u001b[1;33m_exceptions.py\u001b[0m:\u001b[94m14\u001b[0m in \u001b[92mmap_exceptions\u001b[0m             \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m                                                                                                  \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m11 \u001b[0m\u001b[2m│   \u001b[0m\u001b[94mexcept\u001b[0m \u001b[96mException\u001b[0m \u001b[94mas\u001b[0m exc:  \u001b[2m# noqa: PIE786\u001b[0m                                                \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m12 \u001b[0m\u001b[2m│   │   \u001b[0m\u001b[94mfor\u001b[0m from_exc, to_exc \u001b[95min\u001b[0m \u001b[96mmap\u001b[0m.items():                                                \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m13 \u001b[0m\u001b[2m│   │   │   \u001b[0m\u001b[94mif\u001b[0m \u001b[96misinstance\u001b[0m(exc, from_exc):                                                   \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m \u001b[31m❱ \u001b[0m14 \u001b[2m│   │   │   │   \u001b[0m\u001b[94mraise\u001b[0m to_exc(exc) \u001b[94mfrom\u001b[0m \u001b[4;96mexc\u001b[0m                                                  \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m15 \u001b[0m\u001b[2m│   │   \u001b[0m\u001b[94mraise\u001b[0m  \u001b[2m# pragma: nocover\u001b[0m                                                            \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m16 \u001b[0m                                                                                            \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m17 \u001b[0m                                                                                            \u001b[31m│\u001b[0m\n",
+       "\u001b[31m╰──────────────────────────────────────────────────────────────────────────────────────────────────╯\u001b[0m\n",
+       "\u001b[1;91mConnectError: \u001b[0m\u001b[1m[\u001b[0mErrno \u001b[1;36m111\u001b[0m\u001b[1m]\u001b[0m Connection refused\n",
+       "\n",
+       "\u001b[3mThe above exception was the direct cause of the following exception:\u001b[0m\n",
+       "\n",
+       "\u001b[31m╭─\u001b[0m\u001b[31m──────────────────────────────\u001b[0m\u001b[31m \u001b[0m\u001b[1;31mTraceback \u001b[0m\u001b[1;2;31m(most recent call last)\u001b[0m\u001b[31m \u001b[0m\u001b[31m───────────────────────────────\u001b[0m\u001b[31m─╮\u001b[0m\n",
+       "\u001b[31m│\u001b[0m \u001b[2;33m/opt/conda/lib/python3.11/site-packages/unitycatalog/\u001b[0m\u001b[1;33m_base_client.py\u001b[0m:\u001b[94m951\u001b[0m in \u001b[92m_request\u001b[0m             \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m                                                                                                  \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m 948 \u001b[0m\u001b[2m│   │   \u001b[0mlog.debug(\u001b[33m\"\u001b[0m\u001b[33mSending HTTP Request: \u001b[0m\u001b[33m%s\u001b[0m\u001b[33m \u001b[0m\u001b[33m%s\u001b[0m\u001b[33m\"\u001b[0m, request.method, request.url)             \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m 949 \u001b[0m\u001b[2m│   │   \u001b[0m                                                                                  \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m 950 \u001b[0m\u001b[2m│   │   \u001b[0m\u001b[94mtry\u001b[0m:                                                                              \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m \u001b[31m❱ \u001b[0m 951 \u001b[2m│   │   │   \u001b[0mresponse = \u001b[96mself\u001b[0m._client.send(                                                 \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m 952 \u001b[0m\u001b[2m│   │   │   │   \u001b[0mrequest,                                                                  \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m 953 \u001b[0m\u001b[2m│   │   │   │   \u001b[0mstream=stream \u001b[95mor\u001b[0m \u001b[96mself\u001b[0m._should_stream_response_body(request=request),      \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m 954 \u001b[0m\u001b[2m│   │   │   │   \u001b[0m**kwargs,                                                                 \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m                                                                                                  \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m \u001b[2;33m/opt/conda/lib/python3.11/site-packages/httpx/\u001b[0m\u001b[1;33m_client.py\u001b[0m:\u001b[94m914\u001b[0m in \u001b[92msend\u001b[0m                             \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m                                                                                                  \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m 911 \u001b[0m\u001b[2m│   │   \u001b[0m                                                                                  \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m 912 \u001b[0m\u001b[2m│   │   \u001b[0mauth = \u001b[96mself\u001b[0m._build_request_auth(request, auth)                                    \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m 913 \u001b[0m\u001b[2m│   │   \u001b[0m                                                                                  \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m \u001b[31m❱ \u001b[0m 914 \u001b[2m│   │   \u001b[0mresponse = \u001b[96mself\u001b[0m._send_handling_auth(                                              \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m 915 \u001b[0m\u001b[2m│   │   │   \u001b[0mrequest,                                                                      \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m 916 \u001b[0m\u001b[2m│   │   │   \u001b[0mauth=auth,                                                                    \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m 917 \u001b[0m\u001b[2m│   │   │   \u001b[0mfollow_redirects=follow_redirects,                                            \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m                                                                                                  \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m \u001b[2;33m/opt/conda/lib/python3.11/site-packages/httpx/\u001b[0m\u001b[1;33m_client.py\u001b[0m:\u001b[94m942\u001b[0m in \u001b[92m_send_handling_auth\u001b[0m              \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m                                                                                                  \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m 939 \u001b[0m\u001b[2m│   │   │   \u001b[0mrequest = \u001b[96mnext\u001b[0m(auth_flow)                                                     \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m 940 \u001b[0m\u001b[2m│   │   │   \u001b[0m                                                                              \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m 941 \u001b[0m\u001b[2m│   │   │   \u001b[0m\u001b[94mwhile\u001b[0m \u001b[94mTrue\u001b[0m:                                                                   \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m \u001b[31m❱ \u001b[0m 942 \u001b[2m│   │   │   │   \u001b[0mresponse = \u001b[96mself\u001b[0m._send_handling_redirects(                                 \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m 943 \u001b[0m\u001b[2m│   │   │   │   │   \u001b[0mrequest,                                                              \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m 944 \u001b[0m\u001b[2m│   │   │   │   │   \u001b[0mfollow_redirects=follow_redirects,                                    \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m 945 \u001b[0m\u001b[2m│   │   │   │   │   \u001b[0mhistory=history,                                                      \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m                                                                                                  \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m \u001b[2;33m/opt/conda/lib/python3.11/site-packages/httpx/\u001b[0m\u001b[1;33m_client.py\u001b[0m:\u001b[94m979\u001b[0m in \u001b[92m_send_handling_redirects\u001b[0m         \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m                                                                                                  \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m 976 \u001b[0m\u001b[2m│   │   │   \u001b[0m\u001b[94mfor\u001b[0m hook \u001b[95min\u001b[0m \u001b[96mself\u001b[0m._event_hooks[\u001b[33m\"\u001b[0m\u001b[33mrequest\u001b[0m\u001b[33m\"\u001b[0m]:                                     \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m 977 \u001b[0m\u001b[2m│   │   │   │   \u001b[0mhook(request)                                                             \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m 978 \u001b[0m\u001b[2m│   │   │   \u001b[0m                                                                              \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m \u001b[31m❱ \u001b[0m 979 \u001b[2m│   │   │   \u001b[0mresponse = \u001b[96mself\u001b[0m._send_single_request(request)                                 \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m 980 \u001b[0m\u001b[2m│   │   │   \u001b[0m\u001b[94mtry\u001b[0m:                                                                          \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m 981 \u001b[0m\u001b[2m│   │   │   │   \u001b[0m\u001b[94mfor\u001b[0m hook \u001b[95min\u001b[0m \u001b[96mself\u001b[0m._event_hooks[\u001b[33m\"\u001b[0m\u001b[33mresponse\u001b[0m\u001b[33m\"\u001b[0m]:                                \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m 982 \u001b[0m\u001b[2m│   │   │   │   │   \u001b[0mhook(response)                                                        \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m                                                                                                  \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m \u001b[2;33m/opt/conda/lib/python3.11/site-packages/httpx/\u001b[0m\u001b[1;33m_client.py\u001b[0m:\u001b[94m1015\u001b[0m in \u001b[92m_send_single_request\u001b[0m            \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m                                                                                                  \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m1012 \u001b[0m\u001b[2m│   │   │   \u001b[0m)                                                                             \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m1013 \u001b[0m\u001b[2m│   │   \u001b[0m                                                                                  \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m1014 \u001b[0m\u001b[2m│   │   \u001b[0m\u001b[94mwith\u001b[0m request_context(request=request):                                            \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m \u001b[31m❱ \u001b[0m1015 \u001b[2m│   │   │   \u001b[0mresponse = transport.handle_request(request)                                  \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m1016 \u001b[0m\u001b[2m│   │   \u001b[0m                                                                                  \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m1017 \u001b[0m\u001b[2m│   │   \u001b[0m\u001b[94massert\u001b[0m \u001b[96misinstance\u001b[0m(response.stream, SyncByteStream)                                \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m1018 \u001b[0m                                                                                          \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m                                                                                                  \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m \u001b[2;33m/opt/conda/lib/python3.11/site-packages/httpx/_transports/\u001b[0m\u001b[1;33mdefault.py\u001b[0m:\u001b[94m232\u001b[0m in \u001b[92mhandle_request\u001b[0m       \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m                                                                                                  \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m229 \u001b[0m\u001b[2m│   │   │   \u001b[0mcontent=request.stream,                                                        \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m230 \u001b[0m\u001b[2m│   │   │   \u001b[0mextensions=request.extensions,                                                 \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m231 \u001b[0m\u001b[2m│   │   \u001b[0m)                                                                                  \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m \u001b[31m❱ \u001b[0m232 \u001b[2m│   │   \u001b[0m\u001b[94mwith\u001b[0m map_httpcore_exceptions():                                                    \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m233 \u001b[0m\u001b[2m│   │   │   \u001b[0mresp = \u001b[96mself\u001b[0m._pool.handle_request(req)                                          \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m234 \u001b[0m\u001b[2m│   │   \u001b[0m                                                                                   \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m235 \u001b[0m\u001b[2m│   │   \u001b[0m\u001b[94massert\u001b[0m \u001b[96misinstance\u001b[0m(resp.stream, typing.Iterable)                                    \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m                                                                                                  \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m \u001b[2;33m/opt/conda/lib/python3.11/\u001b[0m\u001b[1;33mcontextlib.py\u001b[0m:\u001b[94m158\u001b[0m in \u001b[92m__exit__\u001b[0m                                          \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m                                                                                                  \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m155 \u001b[0m\u001b[2m│   │   │   │   \u001b[0m\u001b[2m# tell if we get the same exception back\u001b[0m                                   \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m156 \u001b[0m\u001b[2m│   │   │   │   \u001b[0mvalue = typ()                                                              \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m157 \u001b[0m\u001b[2m│   │   │   \u001b[0m\u001b[94mtry\u001b[0m:                                                                           \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m \u001b[31m❱ \u001b[0m158 \u001b[2m│   │   │   │   \u001b[0m\u001b[96mself\u001b[0m.gen.throw(typ, value, traceback)                                      \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m159 \u001b[0m\u001b[2m│   │   │   \u001b[0m\u001b[94mexcept\u001b[0m \u001b[96mStopIteration\u001b[0m \u001b[94mas\u001b[0m exc:                                                   \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m160 \u001b[0m\u001b[2m│   │   │   │   \u001b[0m\u001b[2m# Suppress StopIteration *unless* it's the same exception that\u001b[0m             \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m161 \u001b[0m\u001b[2m│   │   │   │   \u001b[0m\u001b[2m# was passed to throw().  This prevents a StopIteration\u001b[0m                    \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m                                                                                                  \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m \u001b[2;33m/opt/conda/lib/python3.11/site-packages/httpx/_transports/\u001b[0m\u001b[1;33mdefault.py\u001b[0m:\u001b[94m86\u001b[0m in                       \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m \u001b[92mmap_httpcore_exceptions\u001b[0m                                                                          \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m                                                                                                  \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m 83 \u001b[0m\u001b[2m│   │   │   \u001b[0m\u001b[94mraise\u001b[0m                                                                          \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m 84 \u001b[0m\u001b[2m│   │   \u001b[0m                                                                                   \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m 85 \u001b[0m\u001b[2m│   │   \u001b[0mmessage = \u001b[96mstr\u001b[0m(exc)                                                                 \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m \u001b[31m❱ \u001b[0m 86 \u001b[2m│   │   \u001b[0m\u001b[94mraise\u001b[0m mapped_exc(message) \u001b[94mfrom\u001b[0m \u001b[4;96mexc\u001b[0m                                                 \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m 87 \u001b[0m                                                                                           \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m 88 \u001b[0m                                                                                           \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m 89 \u001b[0mHTTPCORE_EXC_MAP = {                                                                       \u001b[31m│\u001b[0m\n",
+       "\u001b[31m╰──────────────────────────────────────────────────────────────────────────────────────────────────╯\u001b[0m\n",
+       "\u001b[1;91mConnectError: \u001b[0m\u001b[1m[\u001b[0mErrno \u001b[1;36m111\u001b[0m\u001b[1m]\u001b[0m Connection refused\n",
+       "\n",
+       "\u001b[3mThe above exception was the direct cause of the following exception:\u001b[0m\n",
+       "\n",
+       "\u001b[31m╭─\u001b[0m\u001b[31m──────────────────────────────\u001b[0m\u001b[31m \u001b[0m\u001b[1;31mTraceback \u001b[0m\u001b[1;2;31m(most recent call last)\u001b[0m\u001b[31m \u001b[0m\u001b[31m───────────────────────────────\u001b[0m\u001b[31m─╮\u001b[0m\n",
+       "\u001b[31m│\u001b[0m \u001b[2;33m/home/jovyan/workspaces/\u001b[0m\u001b[1;33muc_oss_catalog_viewer.py\u001b[0m:\u001b[94m147\u001b[0m in \u001b[92mdisplay_catalog\u001b[0m                          \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m                                                                                                  \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m144 \u001b[0m\u001b[2m│   \u001b[0m\u001b[94mtry\u001b[0m:                                                                                   \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m145 \u001b[0m\u001b[2m│   │   \u001b[0mconsole = Console(width=\u001b[94m200\u001b[0m)                                                       \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m146 \u001b[0m\u001b[2m│   │   \u001b[0m\u001b[94mwith\u001b[0m console.pager():                                                              \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m \u001b[31m❱ \u001b[0m147 \u001b[2m│   │   │   \u001b[0mconsole.print(generate_table())                                                \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m148 \u001b[0m\u001b[2m│   \u001b[0m                                                                                       \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m149 \u001b[0m\u001b[2m│   \u001b[0m\u001b[94mexcept\u001b[0m \u001b[96mException\u001b[0m \u001b[94mas\u001b[0m e:                                                                 \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m150 \u001b[0m\u001b[2m│   │   \u001b[0m\u001b[96mprint\u001b[0m()                                                                            \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m                                                                                                  \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m \u001b[2;33m/home/jovyan/workspaces/\u001b[0m\u001b[1;33muc_oss_catalog_viewer.py\u001b[0m:\u001b[94m49\u001b[0m in \u001b[92mgenerate_table\u001b[0m                            \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m                                                                                                  \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m 46 \u001b[0m\u001b[2m│   │   \u001b[0mtable.add_column(\u001b[33m\"\u001b[0m\u001b[33mVol/Tab\u001b[0m\u001b[33m\"\u001b[0m)                                                        \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m 47 \u001b[0m\u001b[2m│   │   \u001b[0mtable.add_column(\u001b[33m\"\u001b[0m\u001b[33mDetails\u001b[0m\u001b[33m\"\u001b[0m)                                                        \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m 48 \u001b[0m\u001b[2m│   │   \u001b[0m                                                                                   \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m \u001b[31m❱ \u001b[0m 49 \u001b[2m│   │   \u001b[0mc_list = uc_client.catalogs.list()                                                 \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m 50 \u001b[0m\u001b[2m│   │   \u001b[0mcatalogs= c_list.catalogs                                                          \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m 51 \u001b[0m\u001b[2m│   │   \u001b[0m\u001b[94mfor\u001b[0m catalog \u001b[95min\u001b[0m catalogs:                                                           \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m 52 \u001b[0m\u001b[2m│   │   │   \u001b[0m\u001b[2m# cat_info = catalog.CatalogInfo\u001b[0m                                               \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m                                                                                                  \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m \u001b[2;33m/opt/conda/lib/python3.11/site-packages/unitycatalog/resources/\u001b[0m\u001b[1;33mcatalogs.py\u001b[0m:\u001b[94m211\u001b[0m in \u001b[92mlist\u001b[0m           \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m                                                                                                  \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m208 \u001b[0m\u001b[2m│   │     \u001b[0m                                                                                 \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m209 \u001b[0m\u001b[2;33m│   │     \u001b[0m\u001b[33mtimeout: Override the client-level default timeout for this request, in second\u001b[0m   \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m210 \u001b[0m\u001b[2;33m│   │   \u001b[0m\u001b[33m\"\"\"\u001b[0m                                                                                \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m \u001b[31m❱ \u001b[0m211 \u001b[2m│   │   \u001b[0m\u001b[94mreturn\u001b[0m \u001b[96mself\u001b[0m._get(                                                                  \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m212 \u001b[0m\u001b[2m│   │   │   \u001b[0m\u001b[33m\"\u001b[0m\u001b[33m/catalogs\u001b[0m\u001b[33m\"\u001b[0m,                                                                   \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m213 \u001b[0m\u001b[2m│   │   │   \u001b[0moptions=make_request_options(                                                  \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m214 \u001b[0m\u001b[2m│   │   │   │   \u001b[0mextra_headers=extra_headers,                                               \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m                                                                                                  \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m \u001b[2;33m/opt/conda/lib/python3.11/site-packages/unitycatalog/\u001b[0m\u001b[1;33m_base_client.py\u001b[0m:\u001b[94m1168\u001b[0m in \u001b[92mget\u001b[0m                 \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m                                                                                                  \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m1165 \u001b[0m\u001b[2m│   │   \u001b[0mopts = FinalRequestOptions.construct(method=\u001b[33m\"\u001b[0m\u001b[33mget\u001b[0m\u001b[33m\"\u001b[0m, url=path, **options)           \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m1166 \u001b[0m\u001b[2m│   │   \u001b[0m\u001b[2m# cast is required because mypy complains about returning Any even though\u001b[0m         \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m1167 \u001b[0m\u001b[2m│   │   \u001b[0m\u001b[2m# it understands the type variables\u001b[0m                                               \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m \u001b[31m❱ \u001b[0m1168 \u001b[2m│   │   \u001b[0m\u001b[94mreturn\u001b[0m cast(ResponseT, \u001b[96mself\u001b[0m.request(cast_to, opts, stream=stream, stream_cls=str  \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m1169 \u001b[0m\u001b[2m│   \u001b[0m                                                                                      \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m1170 \u001b[0m\u001b[2m│   \u001b[0m\u001b[1;95m@overload\u001b[0m                                                                             \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m1171 \u001b[0m\u001b[2m│   \u001b[0m\u001b[94mdef\u001b[0m \u001b[92mpost\u001b[0m(                                                                             \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m                                                                                                  \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m \u001b[2;33m/opt/conda/lib/python3.11/site-packages/unitycatalog/\u001b[0m\u001b[1;33m_base_client.py\u001b[0m:\u001b[94m920\u001b[0m in \u001b[92mrequest\u001b[0m              \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m                                                                                                  \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m 917 \u001b[0m\u001b[2m│   │   \u001b[0mstream: \u001b[96mbool\u001b[0m = \u001b[94mFalse\u001b[0m,                                                             \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m 918 \u001b[0m\u001b[2m│   │   \u001b[0mstream_cls: \u001b[96mtype\u001b[0m[_StreamT] | \u001b[94mNone\u001b[0m = \u001b[94mNone\u001b[0m,                                         \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m 919 \u001b[0m\u001b[2m│   \u001b[0m) -> ResponseT | _StreamT:                                                            \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m \u001b[31m❱ \u001b[0m 920 \u001b[2m│   │   \u001b[0m\u001b[94mreturn\u001b[0m \u001b[96mself\u001b[0m._request(                                                             \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m 921 \u001b[0m\u001b[2m│   │   │   \u001b[0mcast_to=cast_to,                                                              \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m 922 \u001b[0m\u001b[2m│   │   │   \u001b[0moptions=options,                                                              \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m 923 \u001b[0m\u001b[2m│   │   │   \u001b[0mstream=stream,                                                                \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m                                                                                                  \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m \u001b[2;33m/opt/conda/lib/python3.11/site-packages/unitycatalog/\u001b[0m\u001b[1;33m_base_client.py\u001b[0m:\u001b[94m975\u001b[0m in \u001b[92m_request\u001b[0m             \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m                                                                                                  \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m 972 \u001b[0m\u001b[2m│   │   │   \u001b[0mlog.debug(\u001b[33m\"\u001b[0m\u001b[33mEncountered Exception\u001b[0m\u001b[33m\"\u001b[0m, exc_info=\u001b[94mTrue\u001b[0m)                             \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m 973 \u001b[0m\u001b[2m│   │   │   \u001b[0m                                                                              \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m 974 \u001b[0m\u001b[2m│   │   │   \u001b[0m\u001b[94mif\u001b[0m retries > \u001b[94m0\u001b[0m:                                                               \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m \u001b[31m❱ \u001b[0m 975 \u001b[2m│   │   │   │   \u001b[0m\u001b[94mreturn\u001b[0m \u001b[96mself\u001b[0m._retry_request(                                               \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m 976 \u001b[0m\u001b[2m│   │   │   │   │   \u001b[0moptions,                                                              \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m 977 \u001b[0m\u001b[2m│   │   │   │   │   \u001b[0mcast_to,                                                              \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m 978 \u001b[0m\u001b[2m│   │   │   │   │   \u001b[0mretries,                                                              \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m                                                                                                  \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m \u001b[2;33m/opt/conda/lib/python3.11/site-packages/unitycatalog/\u001b[0m\u001b[1;33m_base_client.py\u001b[0m:\u001b[94m1051\u001b[0m in \u001b[92m_retry_request\u001b[0m      \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m                                                                                                  \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m1048 \u001b[0m\u001b[2m│   │   \u001b[0m\u001b[2m# different thread if necessary.\u001b[0m                                                  \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m1049 \u001b[0m\u001b[2m│   │   \u001b[0mtime.sleep(timeout)                                                               \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m1050 \u001b[0m\u001b[2m│   │   \u001b[0m                                                                                  \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m \u001b[31m❱ \u001b[0m1051 \u001b[2m│   │   \u001b[0m\u001b[94mreturn\u001b[0m \u001b[96mself\u001b[0m._request(                                                             \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m1052 \u001b[0m\u001b[2m│   │   │   \u001b[0moptions=options,                                                              \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m1053 \u001b[0m\u001b[2m│   │   │   \u001b[0mcast_to=cast_to,                                                              \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m1054 \u001b[0m\u001b[2m│   │   │   \u001b[0mremaining_retries=remaining,                                                  \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m                                                                                                  \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m \u001b[2;33m/opt/conda/lib/python3.11/site-packages/unitycatalog/\u001b[0m\u001b[1;33m_base_client.py\u001b[0m:\u001b[94m975\u001b[0m in \u001b[92m_request\u001b[0m             \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m                                                                                                  \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m 972 \u001b[0m\u001b[2m│   │   │   \u001b[0mlog.debug(\u001b[33m\"\u001b[0m\u001b[33mEncountered Exception\u001b[0m\u001b[33m\"\u001b[0m, exc_info=\u001b[94mTrue\u001b[0m)                             \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m 973 \u001b[0m\u001b[2m│   │   │   \u001b[0m                                                                              \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m 974 \u001b[0m\u001b[2m│   │   │   \u001b[0m\u001b[94mif\u001b[0m retries > \u001b[94m0\u001b[0m:                                                               \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m \u001b[31m❱ \u001b[0m 975 \u001b[2m│   │   │   │   \u001b[0m\u001b[94mreturn\u001b[0m \u001b[96mself\u001b[0m._retry_request(                                               \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m 976 \u001b[0m\u001b[2m│   │   │   │   │   \u001b[0moptions,                                                              \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m 977 \u001b[0m\u001b[2m│   │   │   │   │   \u001b[0mcast_to,                                                              \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m 978 \u001b[0m\u001b[2m│   │   │   │   │   \u001b[0mretries,                                                              \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m                                                                                                  \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m \u001b[2;33m/opt/conda/lib/python3.11/site-packages/unitycatalog/\u001b[0m\u001b[1;33m_base_client.py\u001b[0m:\u001b[94m1051\u001b[0m in \u001b[92m_retry_request\u001b[0m      \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m                                                                                                  \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m1048 \u001b[0m\u001b[2m│   │   \u001b[0m\u001b[2m# different thread if necessary.\u001b[0m                                                  \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m1049 \u001b[0m\u001b[2m│   │   \u001b[0mtime.sleep(timeout)                                                               \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m1050 \u001b[0m\u001b[2m│   │   \u001b[0m                                                                                  \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m \u001b[31m❱ \u001b[0m1051 \u001b[2m│   │   \u001b[0m\u001b[94mreturn\u001b[0m \u001b[96mself\u001b[0m._request(                                                             \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m1052 \u001b[0m\u001b[2m│   │   │   \u001b[0moptions=options,                                                              \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m1053 \u001b[0m\u001b[2m│   │   │   \u001b[0mcast_to=cast_to,                                                              \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m1054 \u001b[0m\u001b[2m│   │   │   \u001b[0mremaining_retries=remaining,                                                  \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m                                                                                                  \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m \u001b[2;33m/opt/conda/lib/python3.11/site-packages/unitycatalog/\u001b[0m\u001b[1;33m_base_client.py\u001b[0m:\u001b[94m985\u001b[0m in \u001b[92m_request\u001b[0m             \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m                                                                                                  \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m 982 \u001b[0m\u001b[2m│   │   │   │   \u001b[0m)                                                                         \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m 983 \u001b[0m\u001b[2m│   │   │   \u001b[0m                                                                              \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m 984 \u001b[0m\u001b[2m│   │   │   \u001b[0mlog.debug(\u001b[33m\"\u001b[0m\u001b[33mRaising connection error\u001b[0m\u001b[33m\"\u001b[0m)                                         \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m \u001b[31m❱ \u001b[0m 985 \u001b[2m│   │   │   \u001b[0m\u001b[94mraise\u001b[0m APIConnectionError(request=request) \u001b[94mfrom\u001b[0m \u001b[4;96merr\u001b[0m                            \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m 986 \u001b[0m\u001b[2m│   │   \u001b[0m                                                                                  \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m 987 \u001b[0m\u001b[2m│   │   \u001b[0mlog.debug(                                                                        \u001b[31m│\u001b[0m\n",
+       "\u001b[31m│\u001b[0m   \u001b[2m 988 \u001b[0m\u001b[2m│   │   │   \u001b[0m\u001b[33m'\u001b[0m\u001b[33mHTTP Response: \u001b[0m\u001b[33m%s\u001b[0m\u001b[33m \u001b[0m\u001b[33m%s\u001b[0m\u001b[33m \u001b[0m\u001b[33m\"\u001b[0m\u001b[33m%i\u001b[0m\u001b[33m \u001b[0m\u001b[33m%s\u001b[0m\u001b[33m\"\u001b[0m\u001b[33m \u001b[0m\u001b[33m%s\u001b[0m\u001b[33m'\u001b[0m,                                            \u001b[31m│\u001b[0m\n",
+       "\u001b[31m╰──────────────────────────────────────────────────────────────────────────────────────────────────╯\u001b[0m\n",
+       "\u001b[1;91mAPIConnectionError: \u001b[0mConnection error.\n"
+      ]
+     },
+     "metadata": {},
+     "output_type": "display_data"
+    }
+   ],
+   "source": [
+    "%run uc_oss_catalog_viewer.py\n"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "4885e0e1-2a71-420b-b3d3-257e4eb321e3",
+   "metadata": {},
+   "outputs": [],
+   "source": []
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3 (ipykernel)",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.11.9"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}
diff --git a/workspaces/starter.jupyterlab-workspace b/workspaces/starter.jupyterlab-workspace
new file mode 100644
index 0000000..3211591
--- /dev/null
+++ b/workspaces/starter.jupyterlab-workspace
@@ -0,0 +1 @@
+{"data":{"layout-restorer:data":{"main":{"dock":{"type":"split-area","orientation":"vertical","sizes":[0.5,0.5],"children":[{"type":"tab-area","currentIndex":1,"widgets":["terminal:1","terminal:2"]},{"type":"tab-area","currentIndex":0,"widgets":["notebook:workspaces/Untitled1.ipynb"]}]},"current":"terminal:2"},"down":{"size":0,"widgets":[]},"left":{"collapsed":false,"visible":true,"current":"filebrowser","widgets":["filebrowser","running-sessions","git-sessions","@jupyterlab/toc:plugin","extensionmanager.main-view"],"widgetStates":{"jp-running-sessions":{"sizes":[0.16666666666666666,0.16666666666666666,0.16666666666666666,0.16666666666666666,0.16666666666666666,0.16666666666666666],"expansionStates":[false,false,false,false,false,false]},"extensionmanager.main-view":{"sizes":[0.3333333333333333,0.3333333333333333,0.3333333333333333],"expansionStates":[false,false,false]}}},"right":{"collapsed":true,"visible":true,"widgets":["jp-property-inspector","debugger-sidebar"],"widgetStates":{"jp-debugger-sidebar":{"sizes":[0.2,0.2,0.2,0.2,0.2],"expansionStates":[false,false,false,false,false]}}},"relativeSizes":[0.15991077119184194,0.840089228808158,0],"top":{"simpleVisibility":true}},"docmanager:recents":{"opened":[{"path":"workspaces","contentType":"directory","root":"/home/jovyan"},{"path":"workspaces/Untitled1.ipynb","contentType":"notebook","factory":"Notebook","root":"/home/jovyan"}],"closed":[]},"file-browser-filebrowser:cwd":{"path":"workspaces"},"notebook:workspaces/Untitled1.ipynb":{"data":{"path":"workspaces/Untitled1.ipynb","factory":"Notebook"}},"terminal:1":{"data":{"name":"1"}},"terminal:2":{"data":{"name":"2"}}},"metadata":{"id":"starter","last_modified":"2024-07-17T21:18:11.194040+00:00","created":"2024-07-17T21:18:11.194040+00:00"}}
\ No newline at end of file
diff --git a/workspaces/uc_oss_catalog_viewer.py b/workspaces/uc_oss_catalog_viewer.py
new file mode 100644
index 0000000..d61e7e6
--- /dev/null
+++ b/workspaces/uc_oss_catalog_viewer.py
@@ -0,0 +1,167 @@
+#!/usr/bin/env python3
+"""
+SPDX-License-Identifier: Apache-2.0
+Copyright Contributors to the ODPi Egeria project.
+
+A simple UC catalog viewer using the RICH textual interface.
+
+
+"""
+import argparse
+import time
+
+from rich import box
+from rich.console import Console
+from rich.markdown import Markdown
+from rich.table import Table
+from rich.text import Text
+from rich.live import Live
+
+
+from unitycatalog import Unitycatalog
+from unitycatalog.types import (catalog_info, catalog_list_response,
+                                schema_info, schema_list_response,
+                                volume_info, volume_list_response,
+                                )
+
+
+def display_catalog(url:str = "http://egeria.pdr-associates.com:8070"):
+    base_url = url + "/api/2.1/unity-catalog"
+    uc_client = Unitycatalog(base_url=base_url)
+
+    def generate_table() -> Table:
+        """Make a new table."""
+        table = Table(
+            title=f"UC OSS Catalog @ {time.asctime()}",
+            header_style="white on dark_blue",
+            show_lines=True,
+            box=box.ROUNDED,
+            caption=f"Running on {url}",
+            expand=True
+        )
+        table.add_column("Catalog Name")
+        table.add_column("Catalog Comment")
+        table.add_column("Schema Name")
+        table.add_column("Schema Comment")
+        table.add_column("Vol/Tab")
+        table.add_column("Details")
+
+        c_list = uc_client.catalogs.list()
+        catalogs= c_list.catalogs
+        for catalog in catalogs:
+            # cat_info = catalog.CatalogInfo
+            cat_name = catalog.name
+            cat_comment = catalog.comment
+
+            s_list = uc_client.schemas.list(catalog_name = cat_name)
+            schemas = s_list.schemas
+            for schema in schemas:
+                schema_name = schema.name
+                schema_comment = schema.comment
+                v_list = uc_client.volumes.list(catalog_name = cat_name, schema_name = schema_name)
+                volumes = v_list.volumes
+                volume_md = " "
+                volumes_m = "Volumes"
+                volume_m = " "
+                tab_list = uc_client.tables.list(catalog_name = cat_name, schema_name = schema_name)
+                tables = tab_list.tables
+                tables_m = "Tables"
+
+                func_list = uc_client.functions.list(catalog_name = cat_name, schema_name = schema_name)
+                functions = func_list.functions
+                if (functions is not None) and (len(functions) > 0):
+                    function_m = "Functions"
+                    for function in functions:
+                        function_name = function.name
+                        function_comment = function.comment
+                        function_sql = function.sql_data_access
+                        function_id = function.function_id
+                        function_type = function.full_data_type
+                        function_m = (f"{function_m}\n* name: {function_name}\n"
+                                      f"\t* comment: {function_comment}\n"  
+                                      f"\t* function_id: {function_id}\n"
+                                      f"\t* function_type: {function_type}\n"
+                                      f"\t* sql_access: {function_sql}\n")
+                        table.add_row(cat_name, cat_comment, schema_name, schema_comment, Text(function_m))
+                if (volumes is not None) and (len(volumes) > 0):
+                    for volume in volumes:
+                        volume_name = volume.name
+                        volume_comment = volume.comment
+                        volume_created_at = volume.created_at
+                        volume_updated_at = volume.updated_at
+                        volume_id = volume.volume_id
+                        volume_type = volume.volume_type
+                        volume_storage_location = volume.storage_location
+                        volume_m = (f"{volume_m}\n* name: {volume_name}\n"
+                                    f"\t* comment: {volume_comment}\n"
+                                    f"\t* created_at: {volume_created_at}\n"
+                                    f"\t* updated_at: {volume_updated_at}\n"
+                                    f"\t* volume_id: {volume_id}\n"
+                                    f"\t* volume_type: {volume_type}\n"
+                                    f"\t* storage_location: {volume_storage_location}\n")
+                    volumes_m = f"{volumes_m}\n{volume_m}"
+                    table.add_row(cat_name, cat_comment, schema_name, schema_comment, Text(volumes_m))
+                tab_m = " "
+                if (tables is not None) and (len(tables) > 0):
+                    for tab in tables:
+                        tab_name = tab.name
+                        tab_comment = tab.comment
+                        tab_created_at = tab.created_at
+
+                        tab_src_format = tab.data_source_format
+                        tab_id = tab.table_id
+                        tab_type = tab.table_type
+                        tab_updated_at = tab.updated_at
+                        columns = tab.columns
+                        col_m = " "
+                        col_tab = Table()
+                        col_tab.add_column("name")
+                        col_tab.add_column("type")
+                        col_tab.add_column("nullable")
+                        col_tab.add_column("comment")
+
+                        for col in columns:
+                            col_nullable = "true" if col.nullable else "false"
+                            col_tab.add_row(col.name, col.type_text, col_nullable, col.comment)
+
+                        table_m = (f"{tab_m}\n* name: {tab_name}\n"
+                                   f"\t* comment: {tab_comment}\n"
+                                   f"\t* created_at: {tab_created_at}\n"
+                                   f"\t* updated_at: {tab_updated_at}\n"
+                                   f"\t* table_id: {tab_id}\n"
+                                   f"\t* table_type: {tab_type}\n"
+                                   f"\t* src_format: {tab_src_format}\n"
+                                   )
+
+                    tables_m = f"{tables_m}\n{table_m}"
+                    table.add_row(cat_name, cat_comment, schema_name, schema_comment, Text(tables_m), col_tab)
+                fcn_m = " "
+
+
+
+        return table
+
+    try:
+        console = Console(width=200)
+        with console.pager():
+            console.print(generate_table())
+
+    except Exception as e:
+        print()
+        console.print_exception()
+
+    finally:
+        uc_client.close()
+
+
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser()
+    parser.add_argument("--server", help="Name of the server to display status for")
+    parser.add_argument("--url", help="URL Platform to connect to")
+    parser.add_argument("--userid", help="User Id")
+    args = parser.parse_args()
+
+    server = args.server if args.server is not None else "engine-host"
+    url = args.url if args.url is not None else "http://localhost:8080"
+    userid = args.userid if args.userid is not None else 'garygeeke'
+    display_catalog(url)