IMPALA-3398: Add docs to main Impala branch. These are refugees from doc_prototype. They can be rendered with the DITA Open Toolkit version 2.3.3 by:
/tmp/dita-ot-2.3.3/bin/dita \ -i impala.ditamap \ -f html5 \ -o $(mktemp -d) \ -filter impala_html.ditaval Change-Id: I8861e99adc446f659a04463ca78c79200669484f Reviewed-on: http://gerrit.cloudera.org:8080/5014 Reviewed-by: John Russell <[email protected]> Tested-by: John Russell <[email protected]> Project: http://git-wip-us.apache.org/repos/asf/incubator-impala/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-impala/commit/3be0f122 Tree: http://git-wip-us.apache.org/repos/asf/incubator-impala/tree/3be0f122 Diff: http://git-wip-us.apache.org/repos/asf/incubator-impala/diff/3be0f122 Branch: refs/heads/master Commit: 3be0f122a5bb5d3549d9240b95a5d29b4a21b1a2 Parents: 46f5ad4 Author: Jim Apple <[email protected]> Authored: Tue Nov 8 16:49:18 2016 -0800 Committer: Jim Apple <[email protected]> Committed: Thu Nov 17 22:38:44 2016 +0000 ---------------------------------------------------------------------- docs/Cloudera-Impala-Release-Notes.ditamap | 10 + docs/generatingImpalaDoc.md | 73 + docs/images/howto_access_control.png | Bin 0 -> 46499 bytes .../images/howto_per_node_peak_memory_usage.png | Bin 0 -> 83464 bytes docs/images/howto_show_histogram.png | Bin 0 -> 18165 bytes .../images/howto_static_server_pools_config.png | Bin 0 -> 45450 bytes docs/images/impala_arch.jpeg | Bin 0 -> 41900 bytes docs/images/support_send_diagnostic_data.png | Bin 0 -> 34387 bytes docs/impala.ditamap | 1172 +++ docs/impala_html.ditaval | 21 + docs/impala_pdf.ditaval | 21 + docs/impala_sqlref.ditamap | 146 + docs/shared/ImpalaVariables.xml | 52 + docs/shared/impala_common.xml | 3690 +++++++++ docs/topics/impala.xml | 77 + .../impala_abort_on_default_limit_exceeded.xml | 23 + docs/topics/impala_abort_on_error.xml | 44 + docs/topics/impala_admin.xml | 60 + docs/topics/impala_admission.xml | 947 +++ docs/topics/impala_aggregate_functions.xml | 33 + docs/topics/impala_aliases.xml | 87 + .../topics/impala_allow_unsupported_formats.xml | 31 + docs/topics/impala_alter_function.xml | 21 + docs/topics/impala_alter_table.xml | 806 ++ docs/topics/impala_alter_view.xml | 86 + docs/topics/impala_analytic_functions.xml | 1739 +++++ docs/topics/impala_appx_count_distinct.xml | 81 + docs/topics/impala_appx_median.xml | 124 + docs/topics/impala_array.xml | 269 + docs/topics/impala_auditing.xml | 260 + docs/topics/impala_authentication.xml | 39 + docs/topics/impala_authorization.xml | 1621 ++++ docs/topics/impala_avg.xml | 225 + docs/topics/impala_avro.xml | 556 ++ docs/topics/impala_batch_size.xml | 38 + docs/topics/impala_bigint.xml | 102 + docs/topics/impala_bit_functions.xml | 794 ++ docs/topics/impala_boolean.xml | 154 + docs/topics/impala_breakpad.xml | 256 + docs/topics/impala_cdh.xml | 25 + docs/topics/impala_char.xml | 278 + docs/topics/impala_cluster_sizing.xml | 353 + docs/topics/impala_cm_installation.xml | 56 + docs/topics/impala_comments.xml | 53 + docs/topics/impala_complex_types.xml | 2737 +++++++ docs/topics/impala_components.xml | 180 + docs/topics/impala_compression_codec.xml | 98 + docs/topics/impala_compute_stats.xml | 432 ++ docs/topics/impala_concepts.xml | 296 + docs/topics/impala_conditional_functions.xml | 443 ++ docs/topics/impala_config.xml | 57 + docs/topics/impala_config_options.xml | 593 ++ docs/topics/impala_config_performance.xml | 179 + docs/topics/impala_connecting.xml | 202 + docs/topics/impala_conversion_functions.xml | 758 ++ docs/topics/impala_count.xml | 236 + docs/topics/impala_create_data_source.xml | 35 + docs/topics/impala_create_database.xml | 137 + docs/topics/impala_create_function.xml | 492 ++ docs/topics/impala_create_role.xml | 70 + docs/topics/impala_create_table.xml | 832 ++ docs/topics/impala_create_view.xml | 139 + docs/topics/impala_data_sources.xml | 22 + docs/topics/impala_databases.xml | 65 + docs/topics/impala_datatypes.xml | 43 + docs/topics/impala_date.xml | 104 + docs/topics/impala_datetime_functions.xml | 2482 ++++++ docs/topics/impala_ddl.xml | 150 + docs/topics/impala_debug_action.xml | 33 + docs/topics/impala_decimal.xml | 817 ++ docs/topics/impala_default_order_by_limit.xml | 37 + docs/topics/impala_delegation.xml | 88 + docs/topics/impala_delete.xml | 65 + docs/topics/impala_describe.xml | 689 ++ docs/topics/impala_development.xml | 231 + docs/topics/impala_disable_cached_reads.xml | 36 + docs/topics/impala_disable_codegen.xml | 38 + docs/topics/impala_disable_outermost_topn.xml | 29 + .../impala_disable_row_runtime_filtering.xml | 65 + ...impala_disable_streaming_preaggregations.xml | 45 + docs/topics/impala_disable_unsafe_spills.xml | 53 + docs/topics/impala_disk_space.xml | 129 + docs/topics/impala_distinct.xml | 61 + docs/topics/impala_dml.xml | 91 + docs/topics/impala_double.xml | 100 + docs/topics/impala_drop_data_source.xml | 35 + docs/topics/impala_drop_database.xml | 130 + docs/topics/impala_drop_function.xml | 127 + docs/topics/impala_drop_role.xml | 71 + docs/topics/impala_drop_stats.xml | 279 + docs/topics/impala_drop_table.xml | 150 + docs/topics/impala_drop_view.xml | 49 + docs/topics/impala_errata.xml | 1378 ++++ .../impala_exec_single_node_rows_threshold.xml | 96 + docs/topics/impala_explain.xml | 228 + docs/topics/impala_explain_level.xml | 350 + docs/topics/impala_explain_plan.xml | 568 ++ docs/topics/impala_faq.xml | 1877 +++++ docs/topics/impala_faq_base.xml | 24 + docs/topics/impala_features.xml | 21 + docs/topics/impala_file_formats.xml | 270 + docs/topics/impala_fixed_issues.xml | 7092 ++++++++++++++++++ docs/topics/impala_float.xml | 94 + docs/topics/impala_functions.xml | 162 + docs/topics/impala_functions_overview.xml | 116 + docs/topics/impala_glossary.xml | 834 ++ docs/topics/impala_grant.xml | 122 + docs/topics/impala_group_by.xml | 139 + docs/topics/impala_group_concat.xml | 135 + docs/topics/impala_hadoop.xml | 165 + docs/topics/impala_having.xml | 44 + docs/topics/impala_hbase.xml | 904 +++ docs/topics/impala_hbase_cache_blocks.xml | 40 + docs/topics/impala_hbase_caching.xml | 45 + docs/topics/impala_hints.xml | 249 + docs/topics/impala_howto_rm.xml | 420 ++ docs/topics/impala_identifiers.xml | 114 + docs/topics/impala_impala_shell.xml | 101 + docs/topics/impala_incompatible_changes.xml | 1519 ++++ docs/topics/impala_insert.xml | 689 ++ docs/topics/impala_install.xml | 106 + docs/topics/impala_int.xml | 95 + docs/topics/impala_intro.xml | 81 + docs/topics/impala_invalidate_metadata.xml | 233 + docs/topics/impala_isilon.xml | 114 + docs/topics/impala_jdbc.xml | 387 + docs/topics/impala_joins.xml | 534 ++ docs/topics/impala_kerberos.xml | 363 + docs/topics/impala_known_issues.xml | 1812 +++++ docs/topics/impala_kudu.xml | 167 + docs/topics/impala_langref.xml | 74 + docs/topics/impala_langref_sql.xml | 35 + docs/topics/impala_langref_unsupported.xml | 312 + docs/topics/impala_ldap.xml | 354 + docs/topics/impala_limit.xml | 151 + docs/topics/impala_lineage.xml | 113 + docs/topics/impala_literals.xml | 384 + docs/topics/impala_live_progress.xml | 86 + docs/topics/impala_live_summary.xml | 211 + docs/topics/impala_load_data.xml | 256 + docs/topics/impala_logging.xml | 471 ++ docs/topics/impala_map.xml | 267 + docs/topics/impala_math_functions.xml | 1389 ++++ docs/topics/impala_max.xml | 198 + docs/topics/impala_max_block_mgr_memory.xml | 30 + docs/topics/impala_max_errors.xml | 47 + docs/topics/impala_max_io_buffers.xml | 31 + docs/topics/impala_max_num_runtime_filters.xml | 61 + docs/topics/impala_max_scan_range_length.xml | 55 + docs/topics/impala_mem_limit.xml | 212 + docs/topics/impala_min.xml | 197 + docs/topics/impala_misc_functions.xml | 196 + docs/topics/impala_mixed_security.xml | 46 + docs/topics/impala_ndv.xml | 135 + docs/topics/impala_new_features.xml | 4015 ++++++++++ docs/topics/impala_noncm_installation.xml | 171 + docs/topics/impala_num_nodes.xml | 60 + docs/topics/impala_num_scanner_threads.xml | 35 + docs/topics/impala_odbc.xml | 203 + docs/topics/impala_offset.xml | 66 + docs/topics/impala_operators.xml | 1592 ++++ .../impala_optimize_partition_key_scans.xml | 180 + docs/topics/impala_order_by.xml | 318 + docs/topics/impala_parquet.xml | 1160 +++ .../impala_parquet_annotate_strings_utf8.xml | 50 + .../topics/impala_parquet_compression_codec.xml | 26 + ...mpala_parquet_fallback_schema_resolution.xml | 49 + docs/topics/impala_parquet_file_size.xml | 86 + docs/topics/impala_partitioning.xml | 582 ++ docs/topics/impala_perf_benchmarking.xml | 36 + docs/topics/impala_perf_cookbook.xml | 269 + docs/topics/impala_perf_ddl.xml | 42 + docs/topics/impala_perf_hdfs_caching.xml | 609 ++ docs/topics/impala_perf_joins.xml | 506 ++ docs/topics/impala_perf_resources.xml | 60 + docs/topics/impala_perf_skew.xml | 150 + docs/topics/impala_perf_stats.xml | 1031 +++ docs/topics/impala_perf_testing.xml | 175 + docs/topics/impala_performance.xml | 191 + docs/topics/impala_planning.xml | 30 + docs/topics/impala_porting.xml | 623 ++ docs/topics/impala_ports.xml | 440 ++ docs/topics/impala_prefetch_mode.xml | 49 + docs/topics/impala_prereqs.xml | 357 + docs/topics/impala_processes.xml | 134 + docs/topics/impala_proxy.xml | 635 ++ docs/topics/impala_query_lifetime.xml | 31 + docs/topics/impala_query_options.xml | 77 + docs/topics/impala_query_timeout_s.xml | 56 + docs/topics/impala_rcfile.xml | 244 + docs/topics/impala_real.xml | 46 + docs/topics/impala_refresh.xml | 324 + docs/topics/impala_release_notes.xml | 17 + docs/topics/impala_relnotes.xml | 34 + docs/topics/impala_replica_preference.xml | 48 + docs/topics/impala_request_pool.xml | 43 + .../impala_reservation_request_timeout.xml | 38 + docs/topics/impala_reserved_words.xml | 365 + docs/topics/impala_resource_management.xml | 338 + docs/topics/impala_revoke.xml | 101 + docs/topics/impala_rm_initial_mem.xml | 29 + .../topics/impala_runtime_bloom_filter_size.xml | 93 + docs/topics/impala_runtime_filter_max_size.xml | 51 + docs/topics/impala_runtime_filter_min_size.xml | 51 + docs/topics/impala_runtime_filter_mode.xml | 77 + .../impala_runtime_filter_wait_time_ms.xml | 47 + docs/topics/impala_runtime_filtering.xml | 506 ++ docs/topics/impala_s3.xml | 796 ++ docs/topics/impala_s3_skip_insert_staging.xml | 77 + docs/topics/impala_scalability.xml | 833 ++ .../impala_scan_node_codegen_threshold.xml | 75 + docs/topics/impala_schedule_random_replica.xml | 80 + docs/topics/impala_schema_design.xml | 222 + docs/topics/impala_schema_objects.xml | 57 + docs/topics/impala_security.xml | 123 + docs/topics/impala_security_files.xml | 67 + docs/topics/impala_security_guidelines.xml | 108 + docs/topics/impala_security_install.xml | 24 + docs/topics/impala_security_metastore.xml | 40 + docs/topics/impala_security_webui.xml | 66 + docs/topics/impala_select.xml | 206 + docs/topics/impala_seq_compression_mode.xml | 29 + docs/topics/impala_seqfile.xml | 239 + docs/topics/impala_set.xml | 192 + docs/topics/impala_shell_commands.xml | 399 + docs/topics/impala_shell_options.xml | 580 ++ docs/topics/impala_shell_running_commands.xml | 265 + docs/topics/impala_show.xml | 1264 ++++ docs/topics/impala_smallint.xml | 101 + docs/topics/impala_ssl.xml | 267 + docs/topics/impala_stddev.xml | 118 + docs/topics/impala_string.xml | 180 + docs/topics/impala_string_functions.xml | 926 +++ docs/topics/impala_struct.xml | 433 ++ docs/topics/impala_subqueries.xml | 320 + docs/topics/impala_sum.xml | 239 + docs/topics/impala_support_start_over.xml | 30 + docs/topics/impala_sync_ddl.xml | 59 + docs/topics/impala_tables.xml | 258 + docs/topics/impala_timeouts.xml | 172 + docs/topics/impala_timestamp.xml | 445 ++ docs/topics/impala_tinyint.xml | 103 + docs/topics/impala_trouble_bad_results.xml | 25 + docs/topics/impala_trouble_memory.xml | 25 + docs/topics/impala_trouble_query_fail.xml | 24 + docs/topics/impala_trouble_sql.xml | 25 + docs/topics/impala_trouble_startup.xml | 25 + docs/topics/impala_troubleshooting.xml | 447 ++ docs/topics/impala_truncate_table.xml | 184 + docs/topics/impala_tutorial.xml | 2500 ++++++ docs/topics/impala_txtfile.xml | 812 ++ docs/topics/impala_udf.xml | 1933 +++++ docs/topics/impala_union.xml | 152 + docs/topics/impala_update.xml | 65 + docs/topics/impala_upgrading.xml | 378 + docs/topics/impala_upsert.xml | 81 + docs/topics/impala_use.xml | 79 + docs/topics/impala_v_cpu_cores.xml | 39 + docs/topics/impala_varchar.xml | 217 + docs/topics/impala_variance.xml | 129 + docs/topics/impala_views.xml | 187 + docs/topics/impala_webui.xml | 650 ++ docs/topics/impala_window_functions.xml | 23 + docs/topics/impala_with.xml | 66 + 264 files changed, 89657 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-impala/blob/3be0f122/docs/Cloudera-Impala-Release-Notes.ditamap ---------------------------------------------------------------------- diff --git a/docs/Cloudera-Impala-Release-Notes.ditamap b/docs/Cloudera-Impala-Release-Notes.ditamap new file mode 100644 index 0000000..7545b2e --- /dev/null +++ b/docs/Cloudera-Impala-Release-Notes.ditamap @@ -0,0 +1,10 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE map PUBLIC "-//OASIS//DTD DITA Map//EN" "map.dtd"> +<map audience="standalone"> + <title>Cloudera Impala Release Notes</title> + <topicref href="topics/impala_relnotes.xml" audience="HTML standalone"/> + <topicref href="topics/impala_new_features.xml"/> + <topicref href="topics/impala_incompatible_changes.xml"/> + <topicref href="topics/impala_known_issues.xml"/> + <topicref href="topics/impala_fixed_issues.xml"/> +</map> http://git-wip-us.apache.org/repos/asf/incubator-impala/blob/3be0f122/docs/generatingImpalaDoc.md ---------------------------------------------------------------------- diff --git a/docs/generatingImpalaDoc.md b/docs/generatingImpalaDoc.md new file mode 100644 index 0000000..5021e39 --- /dev/null +++ b/docs/generatingImpalaDoc.md @@ -0,0 +1,73 @@ +#Generating HTML or a PDF of Apache Impala (Incubating) Documentation + +##Prerequisites: +Make sure that you have a recent version of a Java JDK installed and that your JAVA\_HOME environment variable is set. This procedure has been tested with JDK 1.8.0. See [Setting JAVA\_HOME](#settingjavahome) at the end of these instructions. + +* Open a terminal window and run the following commands to get the Impala documentation source files from Git: + + <pre><code>git clone https://git-wip-us.apache.org/repos/asf/incubator-impala.git/docs + cd \<local\_directory\> + git checkout doc\_prototype</code></pre> + + Where <code>doc\_prototype</code> is the branch where Impala documentation source files are uploaded. + +* Download the DITA Open Toolkit version 2.3.3 from the DITA Open Toolkit web site: + + [https://github.com/dita-ot/dita-ot/releases/download/2.3.3/dita-ot-2.3.3.zip] (https://github.com/dita-ot/dita-ot/releases/download/2.3.3/dita-ot-2.3.3.zip) + + **Note:** A DITA-OT 2.3.3 User Guide is included in the toolkit. Look for <code>userguide.pdf</code> in the <code>doc</code> directory of the toolkit after you extract it. For example, if you extract the toolkit package to the <code>/Users/\<_username_\>/DITA-OT</code> directory on Mac OS, you will find the <code>userguide.pdf</code> at the following location: + + <code>/Users/\<_username_\>/DITA-OT/doc/userguide.pdf</code> + +##To generate HTML or PDF: + +1. In the directory where you cloned the Impala documentation files, you will find the following important configuration files in the <code>docs</code> subdirectory. These files are used to convert the XML source you downloaded from the Apache site to PDF and HTML: + * <code>impala.ditamap</code>: Tells the DITA Open Toolkit what topics to include in the Impala User/Administration Guide. This guide also includes the Impala SQL Reference. + * <code>impala\_sqlref.ditamap</code>: Tells the DITA Open Toolkit what topics to include in the Impala SQL Reference. + * <code>impala\_html.ditaval</code>: Further defines what topics to include in the Impala HTML output. + * <code>impala\_pdf.ditaval</code>: Further defines what topics to include in the Impala PDF output. +2. Extract the contents of the DITA-OT package into a directory where you want to generate the HTML or the PDF. +3. Open a terminal window and navigate to the directory where you extracted the DITA-OT package. +4. Run one of the following commands, depending on what you want to generate: + * **To generate HTML output of the Impala User and Administration Guide, which includes the Impala SQL Reference, run the following command:** + + <code>./bin/dita -input \<path\_to\_impala.ditamap\> -format html5 -output \<path\_to\_build\_output\_directory\> -filter \<path\_to\_impala\_html.ditaval\></code> + + * **To generate PDF output of the Impala User and Administration Guide, which includes the Impala SQL Reference, run the following command:** + + <code>./bin/dita -input \<path\_to\_impala.ditamap\> -format pdf -output \<path\_to\_build\_output\_directory\> -filter \<path\_to\_impala\_pdf.ditaval\></code> + + * **To generate HTML output of the Impala SQL Reference, run the following command:** + + <code>./bin/dita -input \<path\_to\_impala\_sqlref.ditamap\> -format html5 -output \<path\_to\_build\_output\_directory\> -filter \<path\_to\_impala\_html.ditaval\></code> + + * **To generate PDF output of the Impala SQL Reference, run the following command:** + + <code>./bin/dita -input \<path\_to\_impala\_sqlref.ditamap\> -format pdf -output \<path\_to\_build\_output\_directory\> -filter \<path\_to\_impala\_pdf.ditaval\></code> + + **Note:** For a description of all command-line options, see the _DITA Open Toolkit User Guide_ in the <code>doc</code> directory of your downloaded DITA Open Toolkit. + +5. Go to the output directory that you specified in Step 3 to view the HTML or PDF that you generated. If you generated HTML, open the <code>index.html</code> file with a browser to view the output. + +<a name="settingjavahome" /> +#Setting JAVA\_HOME +</a> + +Set your JAVA\_HOME environment variable to tell your computer where to find the Java executable file. For example, to set your JAVA\_HOME environment on Mac OS X when you the the 1.8.0\_101 version of the Java Development Kit (JDK) installed and you are using the Bash version 3.2 shell, perform the following steps: + +1. Edit your <code>/Users/\<username\>/.bash\_profile</code> file and add the following lines to the end of the file: + + <pre><code>#Set JAVA_HOME + JAVA_HOME=/Library/Java/JavaVirtualMachines/jdk1.8.0_101.jdk/Contents/Home + export JAVA_HOME;</code></pre> + + Where <code>jdk1.8.0\_101.jdk</code> is the version of JDK that you have installed. For example, if you have installed <code>jdk1.8.0\_102.jdk</code>, you would use that value instead. + +2. Test to make sure you have set your JAVA\_HOME correctly: + * Open a terminal window and type: <code>$JAVA\_HOME/bin/java -version</code> + * Press return. If you see something like the following: + <pre><code>java version "1.5.0_16" + Java(TM) 2 Runtime Environment, Standard Edition (build 1.5.0_16-b06-284) + Java HotSpot (TM) Client VM (build 1.5.0\_16-133, mixed mode, sharing)</code></pre> + + Then you've successfully set your JAVA\_HOME environment variable to the binary stored in <code>/Library/Java/JavaVirtualMachines/jdk1.8.0\_101.jdk/Contents/Home</code>. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-impala/blob/3be0f122/docs/images/howto_access_control.png ---------------------------------------------------------------------- diff --git a/docs/images/howto_access_control.png b/docs/images/howto_access_control.png new file mode 100644 index 0000000..7f4b1bd Binary files /dev/null and b/docs/images/howto_access_control.png differ http://git-wip-us.apache.org/repos/asf/incubator-impala/blob/3be0f122/docs/images/howto_per_node_peak_memory_usage.png ---------------------------------------------------------------------- diff --git a/docs/images/howto_per_node_peak_memory_usage.png b/docs/images/howto_per_node_peak_memory_usage.png new file mode 100644 index 0000000..6289a24 Binary files /dev/null and b/docs/images/howto_per_node_peak_memory_usage.png differ http://git-wip-us.apache.org/repos/asf/incubator-impala/blob/3be0f122/docs/images/howto_show_histogram.png ---------------------------------------------------------------------- diff --git a/docs/images/howto_show_histogram.png b/docs/images/howto_show_histogram.png new file mode 100644 index 0000000..5a02f70 Binary files /dev/null and b/docs/images/howto_show_histogram.png differ http://git-wip-us.apache.org/repos/asf/incubator-impala/blob/3be0f122/docs/images/howto_static_server_pools_config.png ---------------------------------------------------------------------- diff --git a/docs/images/howto_static_server_pools_config.png b/docs/images/howto_static_server_pools_config.png new file mode 100644 index 0000000..a5fd527 Binary files /dev/null and b/docs/images/howto_static_server_pools_config.png differ http://git-wip-us.apache.org/repos/asf/incubator-impala/blob/3be0f122/docs/images/impala_arch.jpeg ---------------------------------------------------------------------- diff --git a/docs/images/impala_arch.jpeg b/docs/images/impala_arch.jpeg new file mode 100644 index 0000000..8289469 Binary files /dev/null and b/docs/images/impala_arch.jpeg differ http://git-wip-us.apache.org/repos/asf/incubator-impala/blob/3be0f122/docs/images/support_send_diagnostic_data.png ---------------------------------------------------------------------- diff --git a/docs/images/support_send_diagnostic_data.png b/docs/images/support_send_diagnostic_data.png new file mode 100644 index 0000000..3ae4bea Binary files /dev/null and b/docs/images/support_send_diagnostic_data.png differ
