Update samples for the Feb 2025 Public Hyper API release (#112)

Author: StefanSteiner

Tableau-Supported/CPP/CMakeLists.txt

@@ -105,13 +105,13 @@ add_test(
         WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR})
 
 # -----------------------------------------------------------------------------
-# `insert_spatial_data_to_a_hyper_file.cpp`
+# `insert_geospatial_data_to_a_hyper_file.cpp`
 
-add_executable(insert_spatial_data_to_a_hyper_file insert_spatial_data_to_a_hyper_file.cpp)
-target_link_libraries(insert_spatial_data_to_a_hyper_file PRIVATE Tableau::tableauhyperapi-cxx)
+add_executable(insert_geospatial_data_to_a_hyper_file insert_geospatial_data_to_a_hyper_file.cpp)
+target_link_libraries(insert_geospatial_data_to_a_hyper_file PRIVATE Tableau::tableauhyperapi-cxx)
 add_test(
-        NAME insert_spatial_data_to_a_hyper_file
-        COMMAND ${CMAKE_COMMAND} -E env HYPER_PATH=${HYPER_PATH} $<TARGET_FILE:insert_spatial_data_to_a_hyper_file>
+        NAME insert_geospatial_data_to_a_hyper_file
+        COMMAND ${CMAKE_COMMAND} -E env HYPER_PATH=${HYPER_PATH} $<TARGET_FILE:insert_geospatial_data_to_a_hyper_file>
         WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR})
 
 # -----------------------------------------------------------------------------

…/insert_spatial_data_to_a_hyper_file.cpp …sert_geospatial_data_to_a_hyper_file.cppTableau-Supported/CPP/insert_spatial_data_to_a_hyper_file.cpp renamed to Tableau-Supported/CPP/insert_geospatial_data_to_a_hyper_file.cpp Tableau-Supported/CPP/insert_spatial_data_to_a_hyper_file.cpp renamed to Tableau-Supported/CPP/insert_geospatial_data_to_a_hyper_file.cpp

@@ -1,7 +1,7 @@
 /**
- * \example insert_spatial_data_to_a_hyper_file.cpp
+ * \example insert_geospatial_data_to_a_hyper_file.cpp
  *
- * An example of how to insert spatial data into a single-table Hyper file.
+ * An example of how to insert geospatial data into a single-table Hyper file.
  */
 
 #include <hyperapi/hyperapi.hpp>
@@ -14,10 +14,10 @@
 static const hyperapi::TableDefinition extractTable{
    {"Extract", "Extract"},
    {hyperapi::TableDefinition::Column{"Name", hyperapi::SqlType::text(), hyperapi::Nullability::NotNullable},
-    hyperapi::TableDefinition::Column{"Location", hyperapi::SqlType::geography(), hyperapi::Nullability::NotNullable}}};
+    hyperapi::TableDefinition::Column{"Location", hyperapi::SqlType::tabgeography(), hyperapi::Nullability::NotNullable}}};
 
 static void runInsertSpatialDataToAHyperFile() {
-   std::cout << "EXAMPLE - Insert spatial data into a single table within a new Hyper file" << std::endl;
+   std::cout << "EXAMPLE - Insert geospatial data into a single table within a new Hyper file" << std::endl;
    const std::string pathToDatabase = "data/spatial_data.hyper";
 
    // Starts the Hyper Process with telemetry enabled to send data to Tableau.
@@ -56,15 +56,15 @@ static void runInsertSpatialDataToAHyperFile() {
             hyperapi::TableDefinition::Column{"Location_as_text", hyperapi::SqlType::text(), hyperapi::Nullability::NotNullable}};
 
          // Column 'Name' is inserted into "Extract"."Extract" as-is.
-         // Column 'Location' in "Extract"."Extract" of geography type is computed from Column 'Location_as_text' of text type
-         // using the expression 'CAST("Location_as_text") AS GEOGRAPHY'.
+         // Column 'Location' in "Extract"."Extract" of `tableau.tabgeography` type is computed from Column 'Location_as_text' of `text` type
+         // using the expression 'CAST("Location_as_text") AS TABLEAU.TABGEOGRAPHY'.
          // hyperapi::Inserter::ColumnMapping is used for mapping the CAST expression to Column 'Location'.
-         std::string textToGeographyCastExpression = "CAST(" + hyperapi::escapeName("Location_as_text") + " AS GEOGRAPHY)";
+         std::string textToGeographyCastExpression = "CAST(" + hyperapi::escapeName("Location_as_text") + " AS TABLEAU.TABGEOGRAPHY)";
          std::vector<hyperapi::Inserter::ColumnMapping> columnMappings{
             hyperapi::Inserter::ColumnMapping{"Name"},
             hyperapi::Inserter::ColumnMapping{"Location", textToGeographyCastExpression}};
 
-         // Insert spatial data into the "Extract"."Extract" table using CAST expression.
+         // Insert geospatial data into the "Extract"."Extract" table using CAST expression.
          {
             hyperapi::Inserter inserter(connection, extractTable, columnMappings, inserterDefinition);
             inserter.addRow("Seattle", "point(-122.338083 47.647528)");

Tableau-Supported/Java/insert-spatial-data-to-a-hyper-file/src/main/java/examples/InsertSpatialDataToAHyperFile.java

@@ -13,7 +13,7 @@
 import static com.tableau.hyperapi.Sql.escapeStringLiteral;
 
 /**
- * An example demonstrating spatial data insertion to a hyper file
+ * An example demonstrating geospatial data insertion to a hyper file
  */
 public class InsertSpatialDataToAHyperFile{
     /**
@@ -23,15 +23,15 @@ public class InsertSpatialDataToAHyperFile{
     private static TableDefinition EXTRACT_TABLE = new TableDefinition(
             new TableName("Extract","Extract"))
             .addColumn("Name", SqlType.text(), NOT_NULLABLE)
-            .addColumn("Location", SqlType.geography(), NOT_NULLABLE);
+            .addColumn("Location", SqlType.tabgeography(), NOT_NULLABLE);
 
     /**
      * The main function
      *
      * @param args The args
      */
     public static void main(String[] args) {
-        System.out.println("EXAMPLE - Insert spatial data into a Hyper file");
+        System.out.println("EXAMPLE - Insert geospatial data into a Hyper file");
 
         Path spatialDataPath = Paths.get(getWorkingDirectory(), "spatial_data.hyper");
 
@@ -70,10 +70,10 @@ public static void main(String[] args) {
                 inserterDefintion.add(new TableDefinition.Column("Location_as_text", SqlType.text(), NOT_NULLABLE));
 
                 // Column 'Name' is inserted into "Extract"."Extract" as-is.
-                // Column 'Location' in "Extract"."Extract" of geography type is computed from Column 'Location_as_text' of text type
-                // using the expression 'CAST("Location_as_text") AS GEOGRAPHY'.
+                // Column 'Location' in "Extract"."Extract" of `tableau.tabgeography` type is computed from Column 'Location_as_text' of `text` type
+                // using the expression 'CAST("Location_as_text") AS TABLEAU.TABGEOGRAPHY'.
                 // Inserter.ColumnMapping is used for mapping the CAST expression to Column 'Location'.
-                String textToGeographyCastExpression = "CAST(" + escapeName("Location_as_text") + " AS GEOGRAPHY)";
+                String textToGeographyCastExpression = "CAST(" + escapeName("Location_as_text") + " AS TABLEAU.TABGEOGRAPHY)";
                 List<Inserter.ColumnMapping> columnMappings = new ArrayList<Inserter.ColumnMapping>();
                 columnMappings.add(new Inserter.ColumnMapping("Name"));
                 columnMappings.add(new Inserter.ColumnMapping("Location", textToGeographyCastExpression));