Merge pull request #1 from beckandros/master

Athena edits

Author: scmacdon

java/example_code/athena/src/main/java/aws/example/athena/AthenaClientFactory.java

@@ -1,4 +1,4 @@
-//snippet-sourcedescription:[AthenaClientFactory.java demonstrates how to create and configure an Amazon Athena client]
+//snippet-sourcedescription:[AthenaClientFactory.java demonstrates how to create and configure an Amazon Athena client.]
 //snippet-keyword:[Java]
 //snippet-sourcesyntax:[java]
 //snippet-keyword:[Code Sample]
@@ -23,9 +23,9 @@
 public class AthenaClientFactory
 {
 /**
-   * AmazonAthenaClientBuilder to build Athena with the following properties:
-   * - Set the region of the client
-   * - Use the instance profile from the EC2 instance as the credentials provider
+   * Use AmazonAthenaClientBuilder to build Athena with the following properties:
+   * - Set the AWS Region of the client.
+   * - Use the instance profile from the Amazon EC2 instance as the credentials provider.
    * - Configure the client to increase the execution timeout.
    */
   private final AmazonAthenaClientBuilder builder = AmazonAthenaClientBuilder.standard()

java/example_code/athena/src/main/java/aws/example/athena/CreateNamedQueryExample.java

@@ -1,4 +1,4 @@
-//snippet-sourcedescription:[CreateNamedQueryExample.java demonstrates how to create a named query]
+//snippet-sourcedescription:[CreateNamedQueryExample.java demonstrates how to create a named query.]
 //snippet-keyword:[Java]
 //snippet-sourcesyntax:[java]
 //snippet-keyword:[Code Sample]
@@ -22,7 +22,7 @@ public class CreateNamedQueryExample
 {
   public static void main(String[] args) throws Exception
   {
-      // Build an Athena client
+      // Build an Athena client.
       AthenaClientFactory factory = new AthenaClientFactory();
       AmazonAthena athenaClient = factory.createClient();
 
@@ -33,7 +33,7 @@ public static void main(String[] args) throws Exception
               .withDescription("Sample Description")
               .withName("SampleQuery2");
 
-      // Call Athena to create the named query. If it fails, an exception is thrown.
+      // Call Athena to create the named query. If it fails, throw an exception.
       CreateNamedQueryResult createNamedQueryResult = athenaClient.createNamedQuery(createNamedQueryRequest);
   }
 }

java/example_code/athena/src/main/java/aws/example/athena/DeleteNamedQueryExample.java

@@ -24,31 +24,31 @@ public class DeleteNamedQueryExample
 {
     private static String getNamedQueryId(AmazonAthena athenaClient)
     {
-        // Create the NameQuery Request.
+        // Create the named query request.
         CreateNamedQueryRequest createNamedQueryRequest = new CreateNamedQueryRequest()
                 .withDatabase(ExampleConstants.ATHENA_DEFAULT_DATABASE)
                 .withQueryString(ExampleConstants.ATHENA_SAMPLE_QUERY)
                 .withName("SampleQueryName")
                 .withDescription("Sample Description");
 
-        // Create the named query. If it fails, an exception is thrown.
+        // Create the named query. If it fails, throw an exception.
         CreateNamedQueryResult createNamedQueryResult = athenaClient.createNamedQuery(createNamedQueryRequest);
         return createNamedQueryResult.getNamedQueryId();
     }
 
     public static void main(String[] args) throws Exception
     {
-        // Build an Athena client
+        // Build an Athena client.
         AthenaClientFactory factory = new AthenaClientFactory();
         AmazonAthena athenaClient = factory.createClient();
 
         String sampleNamedQueryId = getNamedQueryId(athenaClient);
 
-        // Create the delete named query request
+        // Create the delete named query request.
         DeleteNamedQueryRequest deleteNamedQueryRequest = new DeleteNamedQueryRequest()
                 .withNamedQueryId(sampleNamedQueryId);
 
-        // Delete the named query
+        // Delete the named query.
         DeleteNamedQueryResult deleteNamedQueryResult = athenaClient.deleteNamedQuery(deleteNamedQueryRequest);
     }
 }

java/example_code/athena/src/main/java/aws/example/athena/ExampleConstants.java

@@ -1,4 +1,4 @@
-//snippet-sourcedescription:[ExampleConstants.java demonstrates how to query a table created by the getting started tutorial in Athena]
+//snippet-sourcedescription:[ExampleConstants.java demonstrates how to query a table created using the getting started tutorial in Amazon Athena.]
 //snippet-keyword:[Java]
 //snippet-sourcesyntax:[java]
 //snippet-keyword:[Code Sample]
@@ -13,7 +13,7 @@ public class ExampleConstants {
 
 	public static final int CLIENT_EXECUTION_TIMEOUT = 100000;
 	public static final String ATHENA_OUTPUT_BUCKET = "s3://my-athena-bucket";
-	// This is querying a table created by the getting started tutorial in Athena
+	// This is querying a table created using the getting started tutorial in Amazon Athena.
 	public static final String ATHENA_SAMPLE_QUERY = "SELECT elb_name, "
 			+ " count(1)"
 			+ " FROM elb_logs"

java/example_code/athena/src/main/java/aws/example/athena/ListNamedQueryExample.java

@@ -28,7 +28,7 @@ public static void main(String[] args) throws Exception
         AthenaClientFactory factory = new AthenaClientFactory();
         AmazonAthena athenaClient = factory.createClient();
 
-        // Build the request
+        // Build the request.
         ListNamedQueriesRequest listNamedQueriesRequest = new ListNamedQueriesRequest();
 
         // Get the list results.
@@ -39,7 +39,7 @@ public static void main(String[] args) throws Exception
 
         while (hasMoreResults) {
             List<String> namedQueryIds = listNamedQueriesResult.getNamedQueryIds();
-            // process named query IDs
+            // Process the named query IDs.
 
             // If nextToken is not null,  there are more results. Get the next page of results.
             if (listNamedQueriesResult.getNextToken() != null) {

java/example_code/athena/src/main/java/aws/example/athena/ListQueryExecutionsExample.java

@@ -24,11 +24,11 @@ public class ListQueryExecutionsExample
 {
   public static void main(String[] args) throws Exception
   {
-      // Build an Athena client
+      // Build an Athena client.
       AthenaClientFactory factory = new AthenaClientFactory();
       AmazonAthena athenaClient = factory.createClient();
 
-      // Build the request
+      // Build the request.
       ListQueryExecutionsRequest listQueryExecutionsRequest = new ListQueryExecutionsRequest();
 
       // Get the list results.
@@ -38,11 +38,11 @@ public static void main(String[] args) throws Exception
       boolean hasMoreResults = true;
       while (hasMoreResults) {
           List<String> queryExecutionIds = listQueryExecutionsResult.getQueryExecutionIds();
-          // process queryExecutionIds.
+          // Process the query execution IDs.
 
           System.out.println(queryExecutionIds);
 
-          //If nextToken is not null, then there are more results. Get the next page of results.
+          // If nextToken is not null, there are more results. Get the next page of results.
           if (listQueryExecutionsResult.getNextToken() != null) {
               listQueryExecutionsResult = athenaClient.listQueryExecutions(
                       listQueryExecutionsRequest.withNextToken(listQueryExecutionsResult.getNextToken()));

java/example_code/athena/src/main/java/aws/example/athena/StartQueryExample.java

@@ -1,4 +1,4 @@
-//snippet-sourcedescription:[StartQueryExample.java demonstrates how to submit a query to Athena for execution, wait till results are available, and then process the results.]
+//snippet-sourcedescription:[StartQueryExample.java demonstrates how to submit a query to Amazon Athena for execution, wait until results are available, and then process the results.]
 //snippet-keyword:[Java]
 //snippet-sourcesyntax:[java]
 //snippet-keyword:[Code Sample]
@@ -27,14 +27,14 @@
 /**
 * StartQueryExample
 * -------------------------------------
-* This code shows how to submit a query to Athena for execution, wait till results
+* This code shows how to submit a query to Amazon Athena for execution, wait until results
 * are available, and then process the results.
 */
 public class StartQueryExample
 {
   public static void main(String[] args) throws InterruptedException
   {
-      // Build an AmazonAthena client
+      // Build an Athena client.
       AthenaClientFactory factory = new AthenaClientFactory();
       AmazonAthena athenaClient = factory.createClient();
 
@@ -50,16 +50,16 @@ public static void main(String[] args) throws InterruptedException
    */
   private static String submitAthenaQuery(AmazonAthena athenaClient)
   {
-      // The QueryExecutionContext allows us to set the Database.
+      // The QueryExecutionContext allows us to set the database.
       QueryExecutionContext queryExecutionContext = new QueryExecutionContext().withDatabase(ExampleConstants.ATHENA_DEFAULT_DATABASE);
 
-      // The result configuration specifies where the results of the query should go in S3 and encryption options
+      // The result configuration specifies where the results of the query should go in Amazon S3 and encryption options.
       ResultConfiguration resultConfiguration = new ResultConfiguration()
               // You can provide encryption options for the output that is written.
               // .withEncryptionConfiguration(encryptionConfiguration)
               .withOutputLocation(ExampleConstants.ATHENA_OUTPUT_BUCKET);
 
-      // Create the StartQueryExecutionRequest to send to Athena which will start the query.
+      // Create the StartQueryExecutionRequest to send to Athena, which will start the query.
       StartQueryExecutionRequest startQueryExecutionRequest = new StartQueryExecutionRequest()
               .withQueryString(ExampleConstants.ATHENA_SAMPLE_QUERY)
               .withQueryExecutionContext(queryExecutionContext)
@@ -70,8 +70,8 @@ private static String submitAthenaQuery(AmazonAthena athenaClient)
   }
 
   /**
-   * Wait for an Athena query to complete, fail or to be cancelled. This is done by polling Athena over an
-   * interval of time. If a query fails or is cancelled, then it will throw an exception.
+   * Wait for an Athena query to complete or fail, or to be canceled. This is done by polling Athena over an
+   * interval of time. If a query fails or is canceled, it will throw an exception.
    */
 
        private static void waitForQueryToComplete(AmazonAthena athenaClient, String queryExecutionId) throws InterruptedException
@@ -85,19 +85,19 @@ private static void waitForQueryToComplete(AmazonAthena athenaClient, String que
           getQueryExecutionResult = athenaClient.getQueryExecution(getQueryExecutionRequest);
           String queryState = getQueryExecutionResult.getQueryExecution().getStatus().getState();
           if (queryState.equals(QueryExecutionState.FAILED.toString())) {
-              throw new RuntimeException("Query Failed to run with Error Message: " + getQueryExecutionResult.getQueryExecution().getStatus().getStateChangeReason());
+              throw new RuntimeException("Query failed to run with error message: " + getQueryExecutionResult.getQueryExecution().getStatus().getStateChangeReason());
           }
           else if (queryState.equals(QueryExecutionState.CANCELLED.toString())) {
-              throw new RuntimeException("Query was cancelled.");
+              throw new RuntimeException("Query was canceled.");
           }
           else if (queryState.equals(QueryExecutionState.SUCCEEDED.toString())) {
               isQueryStillRunning = false;
           }
           else {
-              // Sleep an amount of time before retrying again.
+              // Sleep an amount of time before retrying.
               Thread.sleep(ExampleConstants.SLEEP_AMOUNT_IN_MS);
           }
-          System.out.println("Current Status is: " + queryState);
+          System.out.println("Current state is: " + queryState);
       }
   }
 
@@ -109,8 +109,8 @@ else if (queryState.equals(QueryExecutionState.SUCCEEDED.toString())) {
   private static void processResultRows(AmazonAthena athenaClient, String queryExecutionId)
   {
       GetQueryResultsRequest getQueryResultsRequest = new GetQueryResultsRequest()
-              // Max Results can be set but if its not set,
-              // it will choose the maximum page size
+              // MaxResults can be set, but if it is not set,
+              // it will choose the maximum page size.
               // As of the writing of this code, the maximum value is 1000
               // .withMaxResults(1000)
               .withQueryExecutionId(queryExecutionId);
@@ -138,34 +138,34 @@ private static void processRow(Row row, List<ColumnInfo> columnInfoList)
       for (int i = 0; i < columnInfoList.size(); ++i) {
           switch (columnInfoList.get(i).getType()) {
               case "varchar":
-                  // Convert and Process as String
+                  // Convert and process as String.
                   break;
               case "tinyint":
-                  // Convert and Process as tinyint
+                  // Convert and process as tinyint.
                   break;
               case "smallint":
-                  // Convert and Process as smallint
+                  // Convert and process as smallint.
                   break;
               case "integer":
-                  // Convert and Process as integer
+                  // Convert and process as integer.
                   break;
               case "bigint":
-                  // Convert and Process as bigint
+                  // Convert and process as bigint.
                   break;
               case "double":
-                  // Convert and Process as double
+                  // Convert and process as double.
                   break;
               case "boolean":
-                  // Convert and Process as boolean
+                  // Convert and process as boolean.
                   break;
               case "date":
-                  // Convert and Process as date
+                  // Convert and process as date.
                   break;
               case "timestamp":
-                  // Convert and Process as timestamp
+                  // Convert and process as timestamp.
                   break;
               default:
-                  throw new RuntimeException("Unexpected Type is not expected" + columnInfoList.get(i).getType());
+                  throw new RuntimeException("Unexpected type is not expected" + columnInfoList.get(i).getType());
           }
       }
   }

java/example_code/athena/src/main/java/aws/example/athena/StopQueryExecutionExample.java

@@ -24,32 +24,32 @@
 * StopQueryExecutionExample
 * -------------------------------------
 * This code runs an example query, immediately stops the query, and checks the status of the query to
-* ensure that it was cancelled.
+* ensure that it was canceled.
 */
 public class StopQueryExecutionExample
 {
   public static void main(String[] args) throws Exception
   {
-      // Build an Athena client
+      // Build an Athena client.
       AthenaClientFactory factory = new AthenaClientFactory();
       AmazonAthena athenaClient = factory.createClient();
 
       String sampleQueryExecutionId = submitAthenaQuery(athenaClient);
 
-      // Submit the stop query Request
+      // Submit the stop query request.
       StopQueryExecutionRequest stopQueryExecutionRequest = new StopQueryExecutionRequest()
               .withQueryExecutionId(sampleQueryExecutionId);
 
       StopQueryExecutionResult stopQueryExecutionResult = athenaClient.stopQueryExecution(stopQueryExecutionRequest);
 
-      // Ensure that the query was stopped
+      // Ensure that the query was stopped.
       GetQueryExecutionRequest getQueryExecutionRequest = new GetQueryExecutionRequest()
               .withQueryExecutionId(sampleQueryExecutionId);
 
       GetQueryExecutionResult getQueryExecutionResult = athenaClient.getQueryExecution(getQueryExecutionRequest);
       if (getQueryExecutionResult.getQueryExecution().getStatus().getState().equals(QueryExecutionState.CANCELLED)) {
-          // Query was cancelled.
-          System.out.println("Query has been cancelled");
+          // Query was canceled.
+          System.out.println("Query has been canceled");
       }
   }