Merge pull request #1985 from schemacrawler/operations

Create submodule for operations, and add a tablesample command

Author: schemacrawler

.github/workflows/early-release.yml

@@ -81,13 +81,15 @@ jobs:
       name: Setup Docker Buildx
       uses: docker/setup-buildx-action@v3
 
-    - name: Log into Docker Hub
+    - id: docker-login
+      name: Log into Docker Hub
       uses: docker/login-action@v3
       with:
         username: ${{ secrets.DOCKER_USERNAME }}
         password: ${{ secrets.DOCKER_PASSWORD }}
 
-    - name: Build and Push Docker Image
+    - id: build-docker-image
+      name: Build and Push Docker Image
       uses: docker/build-push-action@v6
       with:
         file: ./schemacrawler-docker/Dockerfile

.github/workflows/release.yml

@@ -62,13 +62,15 @@ jobs:
       name: Setup Docker Buildx
       uses: docker/setup-buildx-action@v3
 
-    - name: Log into Docker Hub
+    - id: docker-login
+      name: Log into Docker Hub
       uses: docker/login-action@v3
       with:
         username: ${{ secrets.DOCKER_USERNAME }}
         password: ${{ secrets.DOCKER_PASSWORD }}
 
-    - name: Build and Push Docker Image
+    - id: build-docker-image
+      name: Build and Push Docker Image
       uses: docker/build-push-action@v6
       with:
         file: ./schemacrawler-docker/Dockerfile

pom.xml

@@ -23,6 +23,7 @@
     <module>schemacrawler-loader</module>
     <module>schemacrawler-text</module>
     <module>schemacrawler-diagram</module>
+    <module>schemacrawler-operations</module>
     <module>schemacrawler</module>
     <!-- Additional functionality -->
     <module>schemacrawler-commandline</module>

schemacrawler-api/src/main/java/schemacrawler/schemacrawler/InformationSchemaKey.java

@@ -12,6 +12,7 @@
 import static schemacrawler.schemacrawler.InformationSchemaKeyType.DATABASE_METADATA;
 import static schemacrawler.schemacrawler.InformationSchemaKeyType.INFORMATION_SCHEMA;
 import static schemacrawler.schemacrawler.InformationSchemaKeyType.METADATA_EXTENSION;
+import static schemacrawler.schemacrawler.InformationSchemaKeyType.OPERATION;
 
 public enum InformationSchemaKey {
   ADDITIONAL_COLUMN_ATTRIBUTES(ADDITIONAL_INFO),
@@ -21,14 +22,13 @@ public enum InformationSchemaKey {
   DATABASE_USERS(ADDITIONAL_INFO),
   EXT_HIDDEN_TABLE_COLUMNS(METADATA_EXTENSION),
   EXT_INDEXES(METADATA_EXTENSION),
-  EXT_TABLE_CONSTRAINTS(METADATA_EXTENSION),
   EXT_SYNONYMS(METADATA_EXTENSION),
   EXT_TABLES(METADATA_EXTENSION),
+  EXT_TABLE_CONSTRAINTS(METADATA_EXTENSION),
   FOREIGN_KEYS(DATABASE_METADATA),
   FUNCTIONS(DATABASE_METADATA),
   FUNCTION_COLUMNS(DATABASE_METADATA),
   INDEXES(DATABASE_METADATA),
-  TYPE_INFO(DATABASE_METADATA),
   PRIMARY_KEYS(DATABASE_METADATA),
   PROCEDURES(DATABASE_METADATA),
   PROCEDURE_COLUMNS(DATABASE_METADATA),
@@ -38,10 +38,12 @@ public enum InformationSchemaKey {
   SERVER_INFORMATION(ADDITIONAL_INFO),
   TABLES(DATABASE_METADATA),
   TABLE_COLUMNS(DATABASE_METADATA),
-  TABLE_PRIVILEGES(DATABASE_METADATA),
   TABLE_COLUMN_PRIVILEGES(DATABASE_METADATA),
   TABLE_CONSTRAINTS(INFORMATION_SCHEMA),
+  TABLE_PRIVILEGES(DATABASE_METADATA),
+  TABLESAMPLE(OPERATION), // TABLESAMPLE (no underscore) is an operation
   TRIGGERS(INFORMATION_SCHEMA),
+  TYPE_INFO(DATABASE_METADATA),
   VIEWS(INFORMATION_SCHEMA),
   VIEW_TABLE_USAGE(INFORMATION_SCHEMA),
   ;

schemacrawler-api/src/main/java/schemacrawler/schemacrawler/InformationSchemaKeyType.java

@@ -12,5 +12,6 @@ public enum InformationSchemaKeyType {
   ADDITIONAL_INFO,
   INFORMATION_SCHEMA,
   DATABASE_METADATA,
-  METADATA_EXTENSION
+  METADATA_EXTENSION,
+  OPERATION
 }

schemacrawler-api/src/main/java/schemacrawler/schemacrawler/QueryUtility.java

@@ -183,7 +183,7 @@ private static Map<String, String> makeVariablesMap(
       tableProperties.put("tablename", table.getName());
       tableProperties.put("columns", MetaDataUtility.joinColumns(columns, false, identifiers));
       tableProperties.put(
-          "orderbycolumns", MetaDataUtility.joinColumns(columns, true, identifiers));
+          "basiccolumns", MetaDataUtility.joinColumns(columns, true, identifiers));
       tableProperties.put("tabletype", table.getTableType().toString());
     }
 

schemacrawler-commandline/pom.xml

@@ -54,6 +54,13 @@
       <type>test-jar</type>
       <scope>test</scope>
     </dependency>
+    <dependency>
+      <groupId>us.fatehi</groupId>
+      <artifactId>schemacrawler-operations</artifactId>
+      <version>${project.version}</version>
+      <type>test-jar</type>
+      <scope>test</scope>
+    </dependency>
 
     <dependency>
       <groupId>com.typesafe</groupId>

schemacrawler-commandline/src/test/java/schemacrawler/test/AvailablePluginsTest.java

@@ -45,7 +45,7 @@ public void availableCommands() {
     assertThat(
         new AvailableCommands(),
         contains(
-            "brief", "count", "details", "dump", "list", "quickdump", "schema", "test-command"));
+            "brief", "count", "details", "dump", "list", "schema", "tablesample", "test-command"));
   }
 
   @Test

schemacrawler-commandline/src/test/java/schemacrawler/test/SpinThroughOperationsCommandLineTest.java

@@ -46,7 +46,7 @@ public static void clean() throws Exception {
   }
 
   protected static Stream<Arguments> spinThroughArguments() {
-    return EnumSet.allOf(OperationType.class).stream()
+    return EnumSet.complementOf(EnumSet.of(OperationType.tablesample)).stream()
         .flatMap(
             operation ->
                 EnumSet.complementOf(EnumSet.of(InfoLevel.unknown)).stream()

schemacrawler-commandline/src/test/resources/shell_commands_output/availableCommands.stdout.txt

@@ -8,12 +8,11 @@ Available SchemaCrawler Commands:
                   constraints
   dump          Show data from all rows in the tables
   list          Show a list of schema objects
-  quickdump     Show data from all rows in the tables, but row order is not
-                  guaranteed - this can be used with a minimum info-level for
-                  speed
   schema        Show the commonly needed detail of the schema, including
                   details of tables, views and routines, columns, primary keys,
                   indexes, foreign keys, and triggers
+  tablesample   Show sample data from tables, but the samples are not the same
+                  from run to run
   test-command  Test command which is not deployed with the release
   <query_name>  Show results of query <query_name>, as specified in the
                   configuration properties file