You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@carbondata.apache.org by ch...@apache.org on 2018/10/17 10:15:00 UTC
[12/20] carbondata-site git commit: modified for 1.5.0 version
http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6ad7599a/content/data-management.html
----------------------------------------------------------------------
diff --git a/content/data-management.html b/content/data-management.html
deleted file mode 100644
index 93528d8..0000000
--- a/content/data-management.html
+++ /dev/null
@@ -1,413 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
- <meta charset="utf-8">
- <meta http-equiv="X-UA-Compatible" content="IE=edge">
- <meta name="viewport" content="width=device-width, initial-scale=1">
- <link href='images/favicon.ico' rel='shortcut icon' type='image/x-icon'>
- <!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags -->
- <title>CarbonData</title>
- <style>
-
- </style>
- <!-- Bootstrap -->
-
- <link rel="stylesheet" href="css/bootstrap.min.css">
- <link href="css/style.css" rel="stylesheet">
- <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
- <!-- WARNING: Respond.js doesn't work if you view the page via file:// -->
- <!--[if lt IE 9]>
- <script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
- <script src="https://oss.maxcdn.scom/respond/1.4.2/respond.min.js"></script>
- <![endif]-->
- <script src="js/jquery.min.js"></script>
- <script src="js/bootstrap.min.js"></script>
-
-
-</head>
-<body>
-<header>
- <nav class="navbar navbar-default navbar-custom cd-navbar-wrapper">
- <div class="container">
- <div class="navbar-header">
- <button aria-controls="navbar" aria-expanded="false" data-target="#navbar" data-toggle="collapse"
- class="navbar-toggle collapsed" type="button">
- <span class="sr-only">Toggle navigation</span>
- <span class="icon-bar"></span>
- <span class="icon-bar"></span>
- <span class="icon-bar"></span>
- </button>
- <a href="index.html" class="logo">
- <img src="images/CarbonDataLogo.png" alt="CarbonData logo" title="CarbocnData logo"/>
- </a>
- </div>
- <div class="navbar-collapse collapse cd_navcontnt" id="navbar">
- <ul class="nav navbar-nav navbar-right navlist-custom">
- <li><a href="index.html" class="hidden-xs"><i class="fa fa-home" aria-hidden="true"></i> </a>
- </li>
- <li><a href="index.html" class="hidden-lg hidden-md hidden-sm">Home</a></li>
- <li class="dropdown">
- <a href="#" class="dropdown-toggle " data-toggle="dropdown" role="button" aria-haspopup="true"
- aria-expanded="false"> Download <span class="caret"></span></a>
- <ul class="dropdown-menu">
- <li>
- <a href="https://dist.apache.org/repos/dist/release/carbondata/1.2.0/"
- target="_blank">Apache CarbonData 1.2.0</a></li>
- <li>
- <a href="https://dist.apache.org/repos/dist/release/carbondata/1.1.1/"
- target="_blank">Apache CarbonData 1.1.1</a></li>
- <li>
- <a href="https://dist.apache.org/repos/dist/release/carbondata/1.1.0/"
- target="_blank">Apache CarbonData 1.1.0</a></li>
- <li>
- <a href="http://archive.apache.org/dist/incubator/carbondata/1.0.0-incubating/"
- target="_blank">Apache CarbonData 1.0.0</a></li>
- <li>
- <a href="http://archive.apache.org/dist/incubator/carbondata/0.2.0-incubating/"
- target="_blank">Apache CarbonData 0.2.0</a></li>
- <li>
- <a href="http://archive.apache.org/dist/incubator/carbondata/0.1.1-incubating/"
- target="_blank">Apache CarbonData 0.1.1</a></li>
- <li>
- <a href="http://archive.apache.org/dist/incubator/carbondata/0.1.0-incubating/"
- target="_blank">Apache CarbonData 0.1.0</a></li>
- <li>
- <a href="https://cwiki.apache.org/confluence/display/CARBONDATA/Releases"
- target="_blank">Release Archive</a></li>
- </ul>
- </li>
- <li><a href="mainpage.html" class="active">Documentation</a></li>
- <li class="dropdown">
- <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-haspopup="true"
- aria-expanded="false">Community <span class="caret"></span></a>
- <ul class="dropdown-menu">
- <li>
- <a href="https://github.com/apache/carbondata/blob/master/docs/How-to-contribute-to-Apache-CarbonData.md"
- target="_blank">Contributing to CarbonData</a></li>
- <li>
- <a href="https://github.com/apache/carbondata/blob/master/docs/release-guide.md"
- target="_blank">Release Guide</a></li>
- <li>
- <a href="https://cwiki.apache.org/confluence/display/CARBONDATA/PMC+and+Committers+member+list"
- target="_blank">Project PMC and Committers</a></li>
- <li>
- <a href="https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=66850609"
- target="_blank">CarbonData Meetups</a></li>
- <li><a href="security.html">Apache CarbonData Security</a></li>
- <li><a href="https://issues.apache.org/jira/browse/CARBONDATA" target="_blank">Apache
- Jira</a></li>
- <li><a href="videogallery.html">CarbonData Videos </a></li>
- </ul>
- </li>
- <li class="dropdown">
- <a href="http://www.apache.org/" class="apache_link hidden-xs dropdown-toggle"
- data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">Apache</a>
- <ul class="dropdown-menu">
- <li><a href="http://www.apache.org/" target="_blank">Apache Homepage</a></li>
- <li><a href="http://www.apache.org/licenses/" target="_blank">License</a></li>
- <li><a href="http://www.apache.org/foundation/sponsorship.html"
- target="_blank">Sponsorship</a></li>
- <li><a href="http://www.apache.org/foundation/thanks.html" target="_blank">Thanks</a></li>
- </ul>
- </li>
-
- <li class="dropdown">
- <a href="http://www.apache.org/" class="hidden-lg hidden-md hidden-sm dropdown-toggle"
- data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">Apache</a>
- <ul class="dropdown-menu">
- <li><a href="http://www.apache.org/" target="_blank">Apache Homepage</a></li>
- <li><a href="http://www.apache.org/licenses/" target="_blank">License</a></li>
- <li><a href="http://www.apache.org/foundation/sponsorship.html"
- target="_blank">Sponsorship</a></li>
- <li><a href="http://www.apache.org/foundation/thanks.html" target="_blank">Thanks</a></li>
- </ul>
- </li>
-
- <li>
- <a href="#" id="search-icon"><i class="fa fa-search" aria-hidden="true"></i></a>
-
- </li>
-
- </ul>
- </div><!--/.nav-collapse -->
- <div id="search-box">
- <form method="get" action="http://www.google.com/search" target="_blank">
- <div class="search-block">
- <table border="0" cellpadding="0" width="100%">
- <tr>
- <td style="width:80%">
- <input type="text" name="q" size=" 5" maxlength="255" value=""
- class="search-input" placeholder="Search...." required/>
- </td>
- <td style="width:20%">
- <input type="submit" value="Search"/></td>
- </tr>
- <tr>
- <td align="left" style="font-size:75%" colspan="2">
- <input type="checkbox" name="sitesearch" value="carbondata.apache.org" checked/>
- <span style=" position: relative; top: -3px;"> Only search for CarbonData</span>
- </td>
- </tr>
- </table>
- </div>
- </form>
- </div>
- </div>
- </nav>
-</header> <!-- end Header part -->
-
-<div class="fixed-padding"></div> <!-- top padding with fixde header -->
-
-<section><!-- Dashboard nav -->
- <div class="container-fluid q">
- <div class="col-sm-12 col-md-12 maindashboard">
- <div class="row">
- <section>
- <div style="padding:10px 15px;">
- <div id="viewpage" name="viewpage">
- <div class="row">
- <div class="col-sm-12 col-md-12">
- <div>
-<h1>
-<a id="data-management" class="anchor" href="#data-management" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Data Management</h1>
-<p>This tutorial is going to introduce you to the conceptual details of data management like:</p>
-<ul>
-<li><a href="#loading-data">Loading Data</a></li>
-<li><a href="#deleting-data">Deleting Data</a></li>
-<li><a href="#compacting-data">Compacting Data</a></li>
-<li><a href="#updating-data">Updating Data</a></li>
-</ul>
-<h2>
-<a id="loading-data" class="anchor" href="#loading-data" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Loading Data</h2>
-<ul>
-<li>
-<p><strong>Scenario</strong></p>
-<p>After creating a table, you can load data to the table using the <a href="dml-operation-on-carbondata.html">LOAD DATA</a> command. The loaded data is available for querying.
-When data load is triggered, the data is encoded in CarbonData format and copied into HDFS CarbonData store path (specified in carbon.properties file)
-in compressed, multi dimensional columnar format for quick analysis queries. The same command can be used to load new data or to
-update the existing data. Only one data load can be triggered for one table. The high cardinality columns of the dictionary encoding are
-automatically recognized and these columns will not be used for dictionary encoding.</p>
-</li>
-<li>
-<p><strong>Procedure</strong></p>
-<p>Data loading is a process that involves execution of multiple steps to read, sort and encode the data in CarbonData store format.
-Each step is executed on different threads. After data loading process is complete, the status (success/partial success) is updated to
-CarbonData store metadata. The table below lists the possible load status.</p>
-</li>
-</ul>
-<table>
-<thead>
-<tr>
-<th>Status</th>
-<th>Description</th>
-</tr>
-</thead>
-<tbody>
-<tr>
-<td>Success</td>
-<td>All the data is loaded into table and no bad records found.</td>
-</tr>
-<tr>
-<td>Partial Success</td>
-<td>Data is loaded into table and bad records are found. Bad records are stored at carbon.badrecords.location.</td>
-</tr>
-</tbody>
-</table>
-<p>In case of failure, the error will be logged in error log. Details of loads can be seen with <a href="dml-operation-on-carbondata.html#show-segments">SHOW SEGMENTS</a> command. The show segment command output consists of :</p>
-<ul>
-<li>SegmentSequenceId</li>
-<li>Status</li>
-<li>Load Start Time</li>
-<li>Load End Time</li>
-</ul>
-<p>The latest load will be displayed first in the output.</p>
-<p>Refer to <a href="dml-operation-on-carbondata.html">DML operations on CarbonData</a> for load commands.</p>
-<h2>
-<a id="deleting-data" class="anchor" href="#deleting-data" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Deleting Data</h2>
-<ul>
-<li>
-<p><strong>Scenario</strong></p>
-<p>If you have loaded wrong data into the table, or too many bad records are present and you want to modify and reload the data, you can delete required data loads.
-The load can be deleted using the Segment Sequence Id or if the table contains date field then the data can be deleted using the date field.
-If there are some specific records that need to be deleted based on some filter condition(s) we can delete by records.</p>
-</li>
-<li>
-<p><strong>Procedure</strong></p>
-<p>The loaded data can be deleted in the following ways:</p>
-<ul>
-<li>
-<p>Delete by Segment ID</p>
-<p>After you get the segment ID of the segment that you want to delete, execute the delete command for the selected segment.
-The status of deleted segment is updated to Marked for delete / Marked for Update.</p>
-</li>
-</ul>
-</li>
-</ul>
-<table>
-<thead>
-<tr>
-<th>SegmentSequenceId</th>
-<th>Status</th>
-<th>Load Start Time</th>
-<th>Load End Time</th>
-</tr>
-</thead>
-<tbody>
-<tr>
-<td>0</td>
-<td>Success</td>
-<td>2015-11-19 19:14:...</td>
-<td>2015-11-19 19:14:...</td>
-</tr>
-<tr>
-<td>1</td>
-<td>Marked for Update</td>
-<td>2015-11-19 19:54:...</td>
-<td>2015-11-19 20:08:...</td>
-</tr>
-<tr>
-<td>2</td>
-<td>Marked for Delete</td>
-<td>2015-11-19 20:25:...</td>
-<td>2015-11-19 20:49:...</td>
-</tr>
-</tbody>
-</table>
-<ul>
-<li>
-<p>Delete by Date Field</p>
-<p>If the table contains date field, you can delete the data based on a specific date.</p>
-</li>
-<li>
-<p>Delete by Record</p>
-<p>To delete records from CarbonData table based on some filter Condition(s).</p>
-<p>For delete commands refer to <a href="dml-operation-on-carbondata.html">DML operations on CarbonData</a>.</p>
-</li>
-<li>
-<p><strong>NOTE</strong>:</p>
-<ul>
-<li>
-<p>When the delete segment DML is called, segment will not be deleted physically from the file system. Instead the segment status will be marked as "Marked for Delete". For the query execution, this deleted segment will be excluded.</p>
-</li>
-<li>
-<p>The deleted segment will be deleted physically during the next load operation and only after the maximum query execution time configured using "max.query.execution.time". By default it is 60 minutes.</p>
-</li>
-<li>
-<p>If the user wants to force delete the segment physically then he can use CLEAN FILES Command.</p>
-</li>
-</ul>
-</li>
-</ul>
-<p>Example :</p>
-<pre><code>CLEAN FILES FOR TABLE table1
-</code></pre>
-<p>This DML will physically delete the segment which are "Marked for delete" and "Compacted" immediately.</p>
-<h2>
-<a id="compacting-data" class="anchor" href="#compacting-data" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Compacting Data</h2>
-<ul>
-<li>
-<p><strong>Scenario</strong></p>
-<p>Frequent data ingestion results in several fragmented CarbonData files in the store directory. Since data is sorted only within each load, the indices perform only within each
-load. This means that there will be one index for each load and as number of data load increases, the number of indices also increases. As each index works only on one load,
-the performance of indices is reduced. CarbonData provides provision for compacting the loads. Compaction process combines several segments into one large segment by merge sorting the data from across the segments.</p>
-</li>
-<li>
-<p><strong>Procedure</strong></p>
-<p>There are two types of compaction Minor and Major compaction.</p>
-<ul>
-<li>
-<p><strong>Minor Compaction</strong></p>
-<p>In minor compaction the user can specify how many loads to be merged. Minor compaction triggers for every data load if the parameter carbon.enable.auto.load.merge is set. If any segments are available to be merged, then compaction will
-run parallel with data load. There are 2 levels in minor compaction.</p>
-<ul>
-<li>Level 1: Merging of the segments which are not yet compacted.</li>
-<li>Level 2: Merging of the compacted segments again to form a bigger segment.</li>
-</ul>
-</li>
-<li>
-<p><strong>Major Compaction</strong></p>
-<p>In Major compaction, many segments can be merged into one big segment. User will specify the compaction size until which segments can be merged. Major compaction is usually done during the off-peak time.</p>
-</li>
-</ul>
-<p>There are number of parameters related to Compaction that can be set in carbon.properties file</p>
-</li>
-</ul>
-<table>
-<thead>
-<tr>
-<th>Parameter</th>
-<th>Default</th>
-<th>Application</th>
-<th>Description</th>
-<th>Valid Values</th>
-</tr>
-</thead>
-<tbody>
-<tr>
-<td>carbon.compaction.level.threshold</td>
-<td>4, 3</td>
-<td>Minor</td>
-<td>This property is for minor compaction which decides how many segments to be merged. Example: If it is set as "2, 3", then minor compaction will be triggered for every 2 segments in level 1. 3 is the number of level 1 compacted segment which is further compacted to new segment in level 2.</td>
-<td>NA</td>
-</tr>
-<tr>
-<td>carbon.major.compaction.size</td>
-<td>1024 MB</td>
-<td>Major</td>
-<td>Major compaction size can be configured using this parameter. Sum of the segments which is below this threshold will be merged.</td>
-<td>NA</td>
-</tr>
-<tr>
-<td>carbon.numberof.preserve.segments</td>
-<td>0</td>
-<td>Minor/Major</td>
-<td>This property configures number of segments to preserve from being compacted. Example: carbon.numberof.preserve.segments=2 then 2 latest segments will always be excluded from the compaction. No segments will be preserved by default.</td>
-<td>0-100</td>
-</tr>
-<tr>
-<td>carbon.allowed.compaction.days</td>
-<td>0</td>
-<td>Minor/Major</td>
-<td>Compaction will merge the segments which are loaded within the specific number of days configured. Example: If the configuration is 2, then the segments which are loaded in the time frame of 2 days only will get merged. Segments which are loaded 2 days apart will not be merged. This is disabled by default.</td>
-<td>0-100</td>
-</tr>
-<tr>
-<td>carbon.number.of.cores.while.compacting</td>
-<td>2</td>
-<td>Minor/Major</td>
-<td>Number of cores which is used to write data during compaction.</td>
-<td>0-100</td>
-</tr>
-</tbody>
-</table>
-<p>For compaction commands refer to <a href="ddl-operation-on-carbondata.html">DDL operations on CarbonData</a></p>
-<h2>
-<a id="updating-data" class="anchor" href="#updating-data" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Updating Data</h2>
-<ul>
-<li>
-<p><strong>Scenario</strong></p>
-<p>Sometimes after the data has been ingested into the System, it is required to be updated. Also there may be situations where some specific columns need to be updated
-on the basis of column expression and optional filter conditions.</p>
-</li>
-<li>
-<p><strong>Procedure</strong></p>
-<p>To update we need to specify the column expression with an optional filter condition(s).</p>
-<p>For update commands refer to <a href="dml-operation-on-carbondata.html">DML operations on CarbonData</a>.</p>
-</li>
-</ul>
-</div>
-</div>
-</div>
-</div>
-<div class="doc-footer">
- <a href="#top" class="scroll-top">Top</a>
-</div>
-</div>
-</section>
-</div>
-</div>
-</div>
-</section><!-- End systemblock part -->
-<script src="js/custom.js"></script>
-</body>
-</html>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6ad7599a/content/datamap-developer-guide.html
----------------------------------------------------------------------
diff --git a/content/datamap-developer-guide.html b/content/datamap-developer-guide.html
index 4b9aa4b..50ac30f 100644
--- a/content/datamap-developer-guide.html
+++ b/content/datamap-developer-guide.html
@@ -52,6 +52,9 @@
aria-expanded="false"> Download <span class="caret"></span></a>
<ul class="dropdown-menu">
<li>
+ <a href="https://dist.apache.org/repos/dist/release/carbondata/1.5.0/"
+ target="_blank">Apache CarbonData 1.5.0</a></li>
+ <li>
<a href="https://dist.apache.org/repos/dist/release/carbondata/1.4.1/"
target="_blank">Apache CarbonData 1.4.1</a></li>
<li>
@@ -179,7 +182,12 @@
<a class="nav__item nav__sub__item" href="./timeseries-datamap-guide.html">Time Series</a>
</div>
- <a class="b-nav__api nav__item" href="./sdk-guide.html">API</a>
+ <div class="nav__item nav__item__with__subs">
+ <a class="b-nav__api nav__item nav__sub__anchor" href="./sdk-guide.html">API</a>
+ <a class="nav__item nav__sub__item" href="./sdk-guide.html">Java SDK</a>
+ <a class="nav__item nav__sub__item" href="./CSDK-guide.html">C++ SDK</a>
+ </div>
+
<a class="b-nav__perf nav__item" href="./performance-tuning.html">Performance Tuning</a>
<a class="b-nav__s3 nav__item" href="./s3-guide.html">S3 Storage</a>
<a class="b-nav__faq nav__item" href="./faq.html">FAQ</a>
@@ -220,7 +228,7 @@ Currently, there are two 2 types of DataMap supported:</p>
<li>MVDataMap: DataMap that leverages Materialized View to accelerate olap style query, like SPJG query (select, predicate, join, groupby)</li>
</ol>
<h3>
-<a id="datamap-provider" class="anchor" href="#datamap-provider" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>DataMap provider</h3>
+<a id="datamap-provider" class="anchor" href="#datamap-provider" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>DataMap Provider</h3>
<p>When user issues <code>CREATE DATAMAP dm ON TABLE main USING 'provider'</code>, the corresponding DataMapProvider implementation will be created and initialized.
Currently, the provider string can be:</p>
<ol>
@@ -229,7 +237,7 @@ Currently, the provider string can be:</p>
<li>class name IndexDataMapFactory implementation: Developer can implement new type of IndexDataMap by extending IndexDataMapFactory</li>
</ol>
<p>When user issues <code>DROP DATAMAP dm ON TABLE main</code>, the corresponding DataMapProvider interface will be called.</p>
-<p>Details about <a href="./datamap-management.html#datamap-management">DataMap Management</a> and supported <a href="./datamap-management.html#overview">DSL</a> are documented <a href="./datamap-management.html">here</a>.</p>
+<p>Click for more details about <a href="./datamap-management.html#datamap-management">DataMap Management</a> and supported <a href="./datamap-management.html#overview">DSL</a>.</p>
<script>
$(function() {
// Show selected style on nav item
http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6ad7599a/content/datamap-management.html
----------------------------------------------------------------------
diff --git a/content/datamap-management.html b/content/datamap-management.html
index e2e89f3..ad22bb8 100644
--- a/content/datamap-management.html
+++ b/content/datamap-management.html
@@ -52,6 +52,9 @@
aria-expanded="false"> Download <span class="caret"></span></a>
<ul class="dropdown-menu">
<li>
+ <a href="https://dist.apache.org/repos/dist/release/carbondata/1.5.0/"
+ target="_blank">Apache CarbonData 1.5.0</a></li>
+ <li>
<a href="https://dist.apache.org/repos/dist/release/carbondata/1.4.1/"
target="_blank">Apache CarbonData 1.4.1</a></li>
<li>
@@ -179,7 +182,12 @@
<a class="nav__item nav__sub__item" href="./timeseries-datamap-guide.html">Time Series</a>
</div>
- <a class="b-nav__api nav__item" href="./sdk-guide.html">API</a>
+ <div class="nav__item nav__item__with__subs">
+ <a class="b-nav__api nav__item nav__sub__anchor" href="./sdk-guide.html">API</a>
+ <a class="nav__item nav__sub__item" href="./sdk-guide.html">Java SDK</a>
+ <a class="nav__item nav__sub__item" href="./CSDK-guide.html">C++ SDK</a>
+ </div>
+
<a class="b-nav__perf nav__item" href="./performance-tuning.html">Performance Tuning</a>
<a class="b-nav__s3 nav__item" href="./s3-guide.html">S3 Storage</a>
<a class="b-nav__faq nav__item" href="./faq.html">FAQ</a>
@@ -294,8 +302,8 @@ If user create MV datamap without specifying <code>WITH DEFERRED REBUILD</code>,
<h3>
<a id="automatic-refresh" class="anchor" href="#automatic-refresh" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Automatic Refresh</h3>
<p>When user creates a datamap on the main table without using <code>WITH DEFERRED REBUILD</code> syntax, the datamap will be managed by system automatically.
-For every data load to the main table, system will immediately triger a load to the datamap automatically. These two data loading (to main table and datamap) is executed in a transactional manner, meaning that it will be either both success or neither success.</p>
-<p>The data loading to datamap is incremental based on Segment concept, avoiding a expesive total rebuild.</p>
+For every data load to the main table, system will immediately trigger a load to the datamap automatically. These two data loading (to main table and datamap) is executed in a transactional manner, meaning that it will be either both success or neither success.</p>
+<p>The data loading to datamap is incremental based on Segment concept, avoiding a expensive total rebuild.</p>
<p>If user perform following command on the main table, system will return failure. (reject the operation)</p>
<ol>
<li>Data management command: <code>UPDATE/DELETE/DELETE SEGMENT</code>.</li>
@@ -310,7 +318,7 @@ not, the operation is allowed, otherwise operation will be rejected by throwing
<p>We do recommend you to use this management for index datamap.</p>
<h3>
<a id="manual-refresh" class="anchor" href="#manual-refresh" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Manual Refresh</h3>
-<p>When user creates a datamap specifying maunal refresh semantic, the datamap is created with status <em>disabled</em> and query will NOT use this datamap until user can issue REBUILD DATAMAP command to build the datamap. For every REBUILD DATAMAP command, system will trigger a full rebuild of the datamap. After rebuild is done, system will change datamap status to <em>enabled</em>, so that it can be used in query rewrite.</p>
+<p>When user creates a datamap specifying manual refresh semantic, the datamap is created with status <em>disabled</em> and query will NOT use this datamap until user can issue REBUILD DATAMAP command to build the datamap. For every REBUILD DATAMAP command, system will trigger a full rebuild of the datamap. After rebuild is done, system will change datamap status to <em>enabled</em>, so that it can be used in query rewrite.</p>
<p>For every new data loading, data update, delete, the related datamap will be made <em>disabled</em>,
which means that the following queries will not benefit from the datamap before it becomes <em>enabled</em> again.</p>
<p>If the main table is dropped by user, the related datamap will be dropped immediately.</p>
@@ -336,7 +344,7 @@ Manual refresh on this datamap will has no impact.</li>
<h3>
<a id="explain" class="anchor" href="#explain" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Explain</h3>
<p>How can user know whether datamap is used in the query?</p>
-<p>User can use EXPLAIN command to know, it will print out something like</p>
+<p>User can set enable.query.statistics = true and use EXPLAIN command to know, it will print out something like</p>
<pre lang="text"><code>== CarbonData Profiler ==
Hit mv DataMap: datamap1
Scan Table: default.datamap1_table
http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6ad7599a/content/ddl-of-carbondata.html
----------------------------------------------------------------------
diff --git a/content/ddl-of-carbondata.html b/content/ddl-of-carbondata.html
index 2582f4d..635d835 100644
--- a/content/ddl-of-carbondata.html
+++ b/content/ddl-of-carbondata.html
@@ -52,6 +52,9 @@
aria-expanded="false"> Download <span class="caret"></span></a>
<ul class="dropdown-menu">
<li>
+ <a href="https://dist.apache.org/repos/dist/release/carbondata/1.5.0/"
+ target="_blank">Apache CarbonData 1.5.0</a></li>
+ <li>
<a href="https://dist.apache.org/repos/dist/release/carbondata/1.4.1/"
target="_blank">Apache CarbonData 1.4.1</a></li>
<li>
@@ -179,7 +182,12 @@
<a class="nav__item nav__sub__item" href="./timeseries-datamap-guide.html">Time Series</a>
</div>
- <a class="b-nav__api nav__item" href="./sdk-guide.html">API</a>
+ <div class="nav__item nav__item__with__subs">
+ <a class="b-nav__api nav__item nav__sub__anchor" href="./sdk-guide.html">API</a>
+ <a class="nav__item nav__sub__item" href="./sdk-guide.html">Java SDK</a>
+ <a class="nav__item nav__sub__item" href="./CSDK-guide.html">C++ SDK</a>
+ </div>
+
<a class="b-nav__perf nav__item" href="./performance-tuning.html">Performance Tuning</a>
<a class="b-nav__s3 nav__item" href="./s3-guide.html">S3 Storage</a>
<a class="b-nav__faq nav__item" href="./faq.html">FAQ</a>
@@ -229,6 +237,8 @@
<li><a href="#caching-at-block-or-blocklet-level">Caching Level</a></li>
<li><a href="#support-flat-folder-same-as-hiveparquet">Hive/Parquet folder Structure</a></li>
<li><a href="#string-longer-than-32000-characters">Extra Long String columns</a></li>
+<li><a href="#compression-for-table">Compression for Table</a></li>
+<li><a href="#bad-records-path">Bad Records Path</a></li>
</ul>
</li>
<li><a href="#create-table-as-select">CREATE TABLE AS SELECT</a></li>
@@ -326,6 +336,10 @@ STORED AS carbondata
<td>Size of blocks to write onto hdfs</td>
</tr>
<tr>
+<td><a href="#table-blocklet-size-configuration">TABLE_BLOCKLET_SIZE</a></td>
+<td>Size of blocklet to write in the file</td>
+</tr>
+<tr>
<td><a href="#table-compaction-configuration">MAJOR_COMPACTION_SIZE</a></td>
<td>Size upto which the segments can be combined into one</td>
</tr>
@@ -346,7 +360,7 @@ STORED AS carbondata
<td>Segments generated within the configured time limit in days will be compacted, skipping others</td>
</tr>
<tr>
-<td><a href="#streaming">streaming</a></td>
+<td><a href="#streaming">STREAMING</a></td>
<td>Whether the table is a streaming table</td>
</tr>
<tr>
@@ -359,11 +373,11 @@ STORED AS carbondata
</tr>
<tr>
<td><a href="#local-dictionary-configuration">LOCAL_DICTIONARY_INCLUDE</a></td>
-<td>Columns for which local dictionary needs to be generated.Useful when local dictionary need not be generated for all string/varchar/char columns</td>
+<td>Columns for which local dictionary needs to be generated. Useful when local dictionary need not be generated for all string/varchar/char columns</td>
</tr>
<tr>
<td><a href="#local-dictionary-configuration">LOCAL_DICTIONARY_EXCLUDE</a></td>
-<td>Columns for which local dictionary generation should be skipped.Useful when local dictionary need not be generated for few string/varchar/char columns</td>
+<td>Columns for which local dictionary generation should be skipped. Useful when local dictionary need not be generated for few string/varchar/char columns</td>
</tr>
<tr>
<td><a href="#caching-minmax-value-for-required-columns">COLUMN_META_CACHE</a></td>
@@ -371,10 +385,10 @@ STORED AS carbondata
</tr>
<tr>
<td><a href="#caching-at-block-or-blocklet-level">CACHE_LEVEL</a></td>
-<td>Column metadata caching level.Whether to cache column metadata of block or blocklet</td>
+<td>Column metadata caching level. Whether to cache column metadata of block or blocklet</td>
</tr>
<tr>
-<td><a href="#support-flat-folder-same-as-hiveparquet">flat_folder</a></td>
+<td><a href="#support-flat-folder-same-as-hiveparquet">FLAT_FOLDER</a></td>
<td>Whether to write all the carbondata files in a single folder.Not writing segments folder during incremental load</td>
</tr>
<tr>
@@ -400,12 +414,8 @@ STORED AS carbondata
Suggested use cases : do dictionary encoding for low cardinality columns, it might help to improve data compression ratio and performance.</p>
<pre><code>TBLPROPERTIES ('DICTIONARY_INCLUDE'='column1, column2')
</code></pre>
+<p><strong>NOTE</strong>: Dictionary Include/Exclude for complex child columns is not supported.</p>
</li>
-</ul>
-<pre><code>```
- NOTE: Dictionary Include/Exclude for complex child columns is not supported.
-</code></pre>
-<ul>
<li>
<h5>
<a id="inverted-index-configuration" class="anchor" href="#inverted-index-configuration" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Inverted Index Configuration</h5>
@@ -421,14 +431,14 @@ Suggested use cases : For high cardinality columns, you can disable the inverted
<ul>
<li>If users don't specify "SORT_COLUMN" property, by default MDK index be built by using all dimension columns except complex data type column.</li>
<li>If this property is specified but with empty argument, then the table will be loaded without sort.</li>
-<li>This supports only string, date, timestamp, short, int, long, and boolean data types.
+<li>This supports only string, date, timestamp, short, int, long, byte and boolean data types.
Suggested use cases : Only build MDK index for required columns,it might help to improve the data loading performance.</li>
</ul>
<pre><code>TBLPROPERTIES ('SORT_COLUMNS'='column1, column3')
OR
TBLPROPERTIES ('SORT_COLUMNS'='')
</code></pre>
-<p>NOTE: Sort_Columns for Complex datatype columns is not supported.</p>
+<p><strong>NOTE</strong>: Sort_Columns for Complex datatype columns is not supported.</p>
</li>
<li>
<h5>
@@ -444,32 +454,43 @@ And if you care about loading resources isolation strictly, because the system u
</li>
</ul>
<pre><code>### Example:
-</code></pre>
-<pre><code> CREATE TABLE IF NOT EXISTS productSchema.productSalesTable (
- productNumber INT,
- productName STRING,
- storeCity STRING,
- storeProvince STRING,
- productCategory STRING,
- productBatch STRING,
- saleQuantity INT,
- revenue INT)
- STORED AS carbondata
- TBLPROPERTIES ('SORT_COLUMNS'='productName,storeCity',
- 'SORT_SCOPE'='NO_SORT')
+
+```
+CREATE TABLE IF NOT EXISTS productSchema.productSalesTable (
+ productNumber INT,
+ productName STRING,
+ storeCity STRING,
+ storeProvince STRING,
+ productCategory STRING,
+ productBatch STRING,
+ saleQuantity INT,
+ revenue INT)
+STORED AS carbondata
+TBLPROPERTIES ('SORT_COLUMNS'='productName,storeCity',
+ 'SORT_SCOPE'='NO_SORT')
+```
</code></pre>
<p><strong>NOTE:</strong> CarbonData also supports "using carbondata". Find example code at <a href="https://github.com/apache/carbondata/blob/master/examples/spark2/src/main/scala/org/apache/carbondata/examples/SparkSessionExample.scala" target=_blank>SparkSessionExample</a> in the CarbonData repo.</p>
<ul>
<li>
<h5>
<a id="table-block-size-configuration" class="anchor" href="#table-block-size-configuration" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Table Block Size Configuration</h5>
-<p>This command is for setting block size of this table, the default value is 1024 MB and supports a range of 1 MB to 2048 MB.</p>
+<p>This property is for setting block size of this table, the default value is 1024 MB and supports a range of 1 MB to 2048 MB.</p>
<pre><code>TBLPROPERTIES ('TABLE_BLOCKSIZE'='512')
</code></pre>
<p><strong>NOTE:</strong> 512 or 512M both are accepted.</p>
</li>
<li>
<h5>
+<a id="table-blocklet-size-configuration" class="anchor" href="#table-blocklet-size-configuration" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Table Blocklet Size Configuration</h5>
+<p>This property is for setting blocklet size in the carbondata file, the default value is 64 MB.
+Blocklet is the minimum IO read unit, in case of point queries reduce blocklet size might improve the query performance.</p>
+<p>Example usage:</p>
+<pre><code>TBLPROPERTIES ('TABLE_BLOCKLET_SIZE'='8')
+</code></pre>
+</li>
+<li>
+<h5>
<a id="table-compaction-configuration" class="anchor" href="#table-compaction-configuration" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Table Compaction Configuration</h5>
<p>These properties are table level compaction configurations, if not specified, system level configurations in carbon.properties will be used.
Following are 5 configurations:</p>
@@ -490,7 +511,7 @@ Following are 5 configurations:</p>
<li>
<h5>
<a id="streaming" class="anchor" href="#streaming" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Streaming</h5>
-<p>CarbonData supports streaming ingestion for real-time data. You can create the ?streaming? table using the following table properties.</p>
+<p>CarbonData supports streaming ingestion for real-time data. You can create the 'streaming' table using the following table properties.</p>
<pre><code>TBLPROPERTIES ('streaming'='true')
</code></pre>
</li>
@@ -534,7 +555,28 @@ Following are 5 configurations:</p>
<p>In case of multi-level complex dataType columns, primitive string/varchar/char columns are considered for local dictionary generation.</p>
</li>
</ul>
-<p>Local dictionary will have to be enabled explicitly during create table or by enabling the <strong>system property</strong> <em><strong>carbon.local.dictionary.enable</strong></em>. By default, Local Dictionary will be disabled for the carbondata table.</p>
+<p>System Level Properties for Local Dictionary:</p>
+<table>
+<thead>
+<tr>
+<th>Properties</th>
+<th>Default value</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>carbon.local.dictionary.enable</td>
+<td>false</td>
+<td>By default, Local Dictionary will be disabled for the carbondata table.</td>
+</tr>
+<tr>
+<td>carbon.local.dictionary.decoder.fallback</td>
+<td>true</td>
+<td>Page Level data will not be maintained for the blocklet. During fallback, actual data will be retrieved from the encoded page data using local dictionary. <strong>NOTE:</strong> Memory footprint decreases significantly as compared to when this property is set to false</td>
+</tr>
+</tbody>
+</table>
<p>Local Dictionary can be configured using the following properties during create table command:</p>
<table>
<thead>
@@ -553,35 +595,37 @@ Following are 5 configurations:</p>
<tr>
<td>LOCAL_DICTIONARY_THRESHOLD</td>
<td>10000</td>
-<td>The maximum cardinality of a column upto which carbondata can try to generate local dictionary (maximum - 100000)</td>
+<td>The maximum cardinality of a column upto which carbondata can try to generate local dictionary (maximum - 100000). <strong>NOTE:</strong> When LOCAL_DICTIONARY_THRESHOLD is defined for Complex columns, the count of distinct records of all child columns are summed up.</td>
</tr>
<tr>
<td>LOCAL_DICTIONARY_INCLUDE</td>
<td>string/varchar/char columns</td>
-<td>Columns for which Local Dictionary has to be generated.<strong>NOTE:</strong> Those string/varchar/char columns which are added into DICTIONARY_INCLUDE option will not be considered for local dictionary generation.This property needs to be configured only when local dictionary needs to be generated for few columns, skipping others.This property takes effect only when <strong>LOCAL_DICTIONARY_ENABLE</strong> is true or <strong>carbon.local.dictionary.enable</strong> is true</td>
+<td>Columns for which Local Dictionary has to be generated.<strong>NOTE:</strong> Those string/varchar/char columns which are added into DICTIONARY_INCLUDE option will not be considered for local dictionary generation. This property needs to be configured only when local dictionary needs to be generated for few columns, skipping others. This property takes effect only when <strong>LOCAL_DICTIONARY_ENABLE</strong> is true or <strong>carbon.local.dictionary.enable</strong> is true</td>
</tr>
<tr>
<td>LOCAL_DICTIONARY_EXCLUDE</td>
<td>none</td>
-<td>Columns for which Local Dictionary need not be generated.This property needs to be configured only when local dictionary needs to be skipped for few columns, generating for others.This property takes effect only when <strong>LOCAL_DICTIONARY_ENABLE</strong> is true or <strong>carbon.local.dictionary.enable</strong> is true</td>
+<td>Columns for which Local Dictionary need not be generated. This property needs to be configured only when local dictionary needs to be skipped for few columns, generating for others. This property takes effect only when <strong>LOCAL_DICTIONARY_ENABLE</strong> is true or <strong>carbon.local.dictionary.enable</strong> is true</td>
</tr>
</tbody>
</table>
<p><strong>Fallback behavior:</strong></p>
<ul>
-<li>When the cardinality of a column exceeds the threshold, it triggers a fallback and the generated dictionary will be reverted and data loading will be continued without dictionary encoding.</li>
+<li>
+<p>When the cardinality of a column exceeds the threshold, it triggers a fallback and the generated dictionary will be reverted and data loading will be continued without dictionary encoding.</p>
+</li>
+<li>
+<p>In case of complex columns, fallback is triggered when the summation value of all child columns' distinct records exceeds the defined LOCAL_DICTIONARY_THRESHOLD value.</p>
+</li>
</ul>
<p><strong>NOTE:</strong> When fallback is triggered, the data loading performance will decrease as encoded data will be discarded and the actual data is written to the temporary sort files.</p>
<p><strong>Points to be noted:</strong></p>
-<ol>
+<ul>
<li>
<p>Reduce Block size:</p>
<p>Number of Blocks generated is less in case of Local Dictionary as compression ratio is high. This may reduce the number of tasks launched during query, resulting in degradation of query performance if the pruned blocks are less compared to the number of parallel tasks which can be run. So it is recommended to configure smaller block size which in turn generates more number of blocks.</p>
</li>
-<li>
-<p>All the page-level data for a blocklet needs to be maintained in memory until all the pages encoded for local dictionary is processed in order to handle fallback. Hence the memory required for local dictionary based table is more and this memory increase is proportional to number of columns.</p>
-</li>
-</ol>
+</ul>
<h3>
<a id="example" class="anchor" href="#example" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Example:</h3>
<pre><code>CREATE TABLE carbontable(
@@ -611,32 +655,32 @@ Following are 5 configurations:</p>
<ul>
<li>If you want no column min/max values to be cached in the driver.</li>
</ul>
-<pre><code>COLUMN_META_CACHE=??
+<pre><code>COLUMN_META_CACHE=''
</code></pre>
<ul>
<li>If you want only col1 min/max values to be cached in the driver.</li>
</ul>
-<pre><code>COLUMN_META_CACHE=?col1?
+<pre><code>COLUMN_META_CACHE='col1'
</code></pre>
<ul>
<li>If you want min/max values to be cached in driver for all the specified columns.</li>
</ul>
-<pre><code>COLUMN_META_CACHE=?col1,col2,col3,??
+<pre><code>COLUMN_META_CACHE='col1,col2,col3,?'
</code></pre>
<p>Columns to be cached can be specified either while creating table or after creation of the table.
During create table operation; specify the columns to be cached in table properties.</p>
<p>Syntax:</p>
-<pre><code>CREATE TABLE [dbName].tableName (col1 String, col2 String, col3 int,?) STORED BY ?carbondata? TBLPROPERTIES (?COLUMN_META_CACHE?=?col1,col2,??)
+<pre><code>CREATE TABLE [dbName].tableName (col1 String, col2 String, col3 int,?) STORED BY 'carbondata' TBLPROPERTIES ('COLUMN_META_CACHE'='col1,col2,?')
</code></pre>
<p>Example:</p>
-<pre><code>CREATE TABLE employee (name String, city String, id int) STORED BY ?carbondata? TBLPROPERTIES (?COLUMN_META_CACHE?=?name?)
+<pre><code>CREATE TABLE employee (name String, city String, id int) STORED BY 'carbondata' TBLPROPERTIES ('COLUMN_META_CACHE'='name')
</code></pre>
<p>After creation of table or on already created tables use the alter table command to configure the columns to be cached.</p>
<p>Syntax:</p>
-<pre><code>ALTER TABLE [dbName].tableName SET TBLPROPERTIES (?COLUMN_META_CACHE?=?col1,col2,??)
+<pre><code>ALTER TABLE [dbName].tableName SET TBLPROPERTIES ('COLUMN_META_CACHE'='col1,col2,?')
</code></pre>
<p>Example:</p>
-<pre><code>ALTER TABLE employee SET TBLPROPERTIES (?COLUMN_META_CACHE?=?city?)
+<pre><code>ALTER TABLE employee SET TBLPROPERTIES ('COLUMN_META_CACHE'='city')
</code></pre>
</li>
<li>
@@ -645,36 +689,36 @@ During create table operation; specify the columns to be cached in table propert
<p>This feature allows you to maintain the cache at Block level, resulting in optimized usage of the memory. The memory consumption is high if the Blocklet level caching is maintained as a Block can have multiple Blocklet.</p>
<p>Following are the valid values for CACHE_LEVEL:</p>
<p><em>Configuration for caching in driver at Block level (default value).</em></p>
-<pre><code>CACHE_LEVEL= ?BLOCK?
+<pre><code>CACHE_LEVEL= 'BLOCK'
</code></pre>
<p><em>Configuration for caching in driver at Blocklet level.</em></p>
-<pre><code>CACHE_LEVEL= ?BLOCKLET?
+<pre><code>CACHE_LEVEL= 'BLOCKLET'
</code></pre>
<p>Cache level can be specified either while creating table or after creation of the table.
During create table operation specify the cache level in table properties.</p>
<p>Syntax:</p>
-<pre><code>CREATE TABLE [dbName].tableName (col1 String, col2 String, col3 int,?) STORED BY ?carbondata? TBLPROPERTIES (?CACHE_LEVEL?=?Blocklet?)
+<pre><code>CREATE TABLE [dbName].tableName (col1 String, col2 String, col3 int,?) STORED BY 'carbondata' TBLPROPERTIES ('CACHE_LEVEL'='Blocklet')
</code></pre>
<p>Example:</p>
-<pre><code>CREATE TABLE employee (name String, city String, id int) STORED BY ?carbondata? TBLPROPERTIES (?CACHE_LEVEL?=?Blocklet?)
+<pre><code>CREATE TABLE employee (name String, city String, id int) STORED BY 'carbondata' TBLPROPERTIES ('CACHE_LEVEL'='Blocklet')
</code></pre>
<p>After creation of table or on already created tables use the alter table command to configure the cache level.</p>
<p>Syntax:</p>
-<pre><code>ALTER TABLE [dbName].tableName SET TBLPROPERTIES (?CACHE_LEVEL?=?Blocklet?)
+<pre><code>ALTER TABLE [dbName].tableName SET TBLPROPERTIES ('CACHE_LEVEL'='Blocklet')
</code></pre>
<p>Example:</p>
-<pre><code>ALTER TABLE employee SET TBLPROPERTIES (?CACHE_LEVEL?=?Blocklet?)
+<pre><code>ALTER TABLE employee SET TBLPROPERTIES ('CACHE_LEVEL'='Blocklet')
</code></pre>
</li>
<li>
<h5>
<a id="support-flat-folder-same-as-hiveparquet" class="anchor" href="#support-flat-folder-same-as-hiveparquet" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Support Flat folder same as Hive/Parquet</h5>
-<p>This feature allows all carbondata and index files to keep directy under tablepath. Currently all carbondata/carbonindex files written under tablepath/Fact/Part0/Segment_NUM folder and it is not same as hive/parquet folder structure. This feature makes all files written will be directly under tablepath, it does not maintain any segment folder structure.This is useful for interoperability between the execution engines and plugin with other execution engines like hive or presto becomes easier.</p>
+<p>This feature allows all carbondata and index files to keep directy under tablepath. Currently all carbondata/carbonindex files written under tablepath/Fact/Part0/Segment_NUM folder and it is not same as hive/parquet folder structure. This feature makes all files written will be directly under tablepath, it does not maintain any segment folder structure. This is useful for interoperability between the execution engines and plugin with other execution engines like hive or presto becomes easier.</p>
<p>Following table property enables this feature and default value is false.</p>
<pre><code> 'flat_folder'='true'
</code></pre>
<p>Example:</p>
-<pre><code>CREATE TABLE employee (name String, city String, id int) STORED BY ?carbondata? TBLPROPERTIES ('flat_folder'='true')
+<pre><code>CREATE TABLE employee (name String, city String, id int) STORED BY 'carbondata' TBLPROPERTIES ('flat_folder'='true')
</code></pre>
</li>
<li>
@@ -698,6 +742,37 @@ TBLPROPERTIES ('LONG_STRING_COLUMNS'='col1,col2')
You can refer to SDKwriterTestCase for example.</p>
<p><strong>NOTE:</strong> The LONG_STRING_COLUMNS can only be string/char/varchar columns and cannot be dictionary_include/sort_columns/complex columns.</p>
</li>
+<li>
+<h5>
+<a id="compression-for-table" class="anchor" href="#compression-for-table" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Compression for table</h5>
+<p>Data compression is also supported by CarbonData.
+By default, Snappy is used to compress the data. CarbonData also support ZSTD compressor.
+User can specify the compressor in the table property:</p>
+<pre><code>TBLPROPERTIES('carbon.column.compressor'='snappy')
+</code></pre>
+<p>or</p>
+<pre><code>TBLPROPERTIES('carbon.column.compressor'='zstd')
+</code></pre>
+<p>If the compressor is configured, all the data loading and compaction will use that compressor.
+If the compressor is not configured, the data loading and compaction will use the compressor from current system property.
+In this scenario, the compressor for each load may differ if the system property is changed each time. This is helpful if you want to change the compressor for a table.
+The corresponding system property is configured in carbon.properties file as below:</p>
+<pre><code>carbon.column.compressor=snappy
+</code></pre>
+<p>or</p>
+<pre><code>carbon.column.compressor=zstd
+</code></pre>
+</li>
+<li>
+<h5>
+<a id="bad-records-path" class="anchor" href="#bad-records-path" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Bad Records Path</h5>
+<p>This property is used to specify the location where bad records would be written.
+As the table path remains the same after rename therefore the user can use this property to
+specify bad records path for the table at the time of creation, so that the same path can
+be later viewed in table description for reference.</p>
+<pre><code> TBLPROPERTIES('BAD_RECORD_PATH'='/opt/badrecords'')
+</code></pre>
+</li>
</ul>
<h2>
<a id="create-table-as-select" class="anchor" href="#create-table-as-select" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>CREATE TABLE AS SELECT</h2>
@@ -735,7 +810,7 @@ carbon.sql("SELECT * FROM target_table").show
<a id="create-external-table" class="anchor" href="#create-external-table" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>CREATE EXTERNAL TABLE</h2>
<p>This function allows user to create external table by specifying location.</p>
<pre><code>CREATE EXTERNAL TABLE [IF NOT EXISTS] [db_name.]table_name
-STORED AS carbondata LOCATION ?$FilesPath?
+STORED AS carbondata LOCATION '$FilesPath'
</code></pre>
<h3>
<a id="create-external-table-on-managed-table-data-location" class="anchor" href="#create-external-table-on-managed-table-data-location" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Create external table on managed table data location.</h3>
@@ -781,7 +856,7 @@ suggest to drop the external table and create again to register table with new s
</code></pre>
<h3>
<a id="example-1" class="anchor" href="#example-1" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Example</h3>
-<pre><code>CREATE DATABASE carbon LOCATION ?hdfs://name_cluster/dir1/carbonstore?;
+<pre><code>CREATE DATABASE carbon LOCATION "hdfs://name_cluster/dir1/carbonstore";
</code></pre>
<h2>
<a id="table-management" class="anchor" href="#table-management" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>TABLE MANAGEMENT</h2>
@@ -826,12 +901,11 @@ TBLPROPERTIES('DICTIONARY_INCLUDE'='col_name,...',
</code></pre>
<pre><code>ALTER TABLE carbon ADD COLUMNS (a1 INT, b1 STRING) TBLPROPERTIES('DEFAULT.VALUE.a1'='10')
</code></pre>
-<p>NOTE: Add Complex datatype columns is not supported.</p>
+<p><strong>NOTE:</strong> Add Complex datatype columns is not supported.</p>
</li>
</ul>
-<p>Users can specify which columns to include and exclude for local dictionary generation after adding new columns. These will be appended with the already existing local dictionary include and exclude columns of main table respectively.</p>
-<pre><code> ALTER TABLE carbon ADD COLUMNS (a1 STRING, b1 STRING) TBLPROPERTIES('LOCAL_DICTIONARY_INCLUDE'='a1','LOCAL_DICTIONARY_EXCLUDE'='b1')
-</code></pre>
+<p>Users can specify which columns to include and exclude for local dictionary generation after adding new columns. These will be appended with the already existing local dictionary include and exclude columns of main table respectively.
+<code>ALTER TABLE carbon ADD COLUMNS (a1 STRING, b1 STRING) TBLPROPERTIES('LOCAL_DICTIONARY_INCLUDE'='a1','LOCAL_DICTIONARY_EXCLUDE'='b1')</code></p>
<ul>
<li>
<h5>
@@ -846,7 +920,7 @@ ALTER TABLE test_db.carbon DROP COLUMNS (b1)
ALTER TABLE carbon DROP COLUMNS (c1,d1)
</code></pre>
-<p>NOTE: Drop Complex child column is not supported.</p>
+<p><strong>NOTE:</strong> Drop Complex child column is not supported.</p>
</li>
<li>
<h5>
@@ -876,12 +950,14 @@ Change of decimal data type from lower precision to higher precision will only b
<pre><code> ALTER TABLE [db_name.]table_name COMPACT 'SEGMENT_INDEX'
</code></pre>
<pre><code>Examples:
-```
-ALTER TABLE test_db.carbon COMPACT 'SEGMENT_INDEX'
-```
-**NOTE:**
+</code></pre>
+<pre><code> ALTER TABLE test_db.carbon COMPACT 'SEGMENT_INDEX'
+ ```
+
+ **NOTE:**
+
+ * Merge index is not supported on streaming table.
-* Merge index is not supported on streaming table.
</code></pre>
</li>
<li>
@@ -935,7 +1011,7 @@ STORED AS carbondata
<p>Example:</p>
<pre><code>CREATE TABLE IF NOT EXISTS productSchema.productSalesTable (
productNumber Int COMMENT 'unique serial number for product')
-COMMENT ?This is table comment?
+COMMENT "This is table comment"
STORED AS carbondata
TBLPROPERTIES ('DICTIONARY_INCLUDE'='productNumber')
</code></pre>
@@ -972,7 +1048,7 @@ COMMENT ?This is table comment?
PARTITIONED BY (productCategory STRING, productBatch STRING)
STORED AS carbondata
</code></pre>
-<p>NOTE: Hive partition is not supported on complex datatype columns.</p>
+<p><strong>NOTE:</strong> Hive partition is not supported on complex datatype columns.</p>
<h4>
<a id="show-partitions" class="anchor" href="#show-partitions" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Show Partitions</h4>
<p>This command gets the Hive partition information of the table</p>