http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6ad7599a/content/ddl-operation-on-carbondata.html ---------------------------------------------------------------------- diff --git a/content/ddl-operation-on-carbondata.html b/content/ddl-operation-on-carbondata.html deleted file mode 100644 index 444428f..0000000 --- a/content/ddl-operation-on-carbondata.html +++ /dev/null @@ -1,748 +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="ddl-operations-on-carbondata" class="anchor" href="#ddl-operations-on-carbondata" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>DDL Operations on CarbonData</h1> -<p>This tutorial guides you through the data definition language support provided by CarbonData.</p> -<h2> -<a id="overview" class="anchor" href="#overview" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Overview</h2> -<p>The following DDL operations are supported in CarbonData :</p> -<ul> -<li><a href="#create-table">CREATE TABLE</a></li> -<li><a href="#show-table">SHOW TABLE</a></li> -<li> -<a href="#alter-table">ALTER TABLE</a> -<ul> -<li><a href="#rename-table">RENAME TABLE</a></li> -<li><a href="#add-column">ADD COLUMN</a></li> -<li><a href="#drop-columns">DROP COLUMNS</a></li> -<li><a href="#change-data-type">CHANGE DATA TYPE</a></li> -</ul> -</li> -<li><a href="#drop-table">DROP TABLE</a></li> -<li><a href="#compaction">COMPACTION</a></li> -<li><a href="#bucketing">BUCKETING</a></li> -</ul> -<h2> -<a id="create-table" class="anchor" href="#create-table" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>CREATE TABLE</h2> -<p>This command can be used to create a CarbonData table by specifying the list of fields along with the table properties.</p> -<pre><code> CREATE TABLE [IF NOT EXISTS] [db_name.]table_name - [(col_name data_type , ...)] - STORED BY 'carbondata' - [TBLPROPERTIES (property_name=property_value, ...)] - // All Carbon's additional table options will go into properties -</code></pre> -<h3> -<a id="parameter-description" class="anchor" href="#parameter-description" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Parameter Description</h3> -<table> -<thead> -<tr> -<th>Parameter</th> -<th>Description</th> -<th>Optional</th> -</tr> -</thead> -<tbody> -<tr> -<td>db_name</td> -<td>Name of the database. Database name should consist of alphanumeric characters and underscore(_) special character.</td> -<td>YES</td> -</tr> -<tr> -<td>field_list</td> -<td>Comma separated List of fields with data type. The field names should consist of alphanumeric characters and underscore(_) special character.</td> -<td>NO</td> -</tr> -<tr> -<td>table_name</td> -<td>The name of the table in Database. Table name should consist of alphanumeric characters and underscore(_) special character.</td> -<td>NO</td> -</tr> -<tr> -<td>STORED BY</td> -<td>"org.apache.carbondata.format", identifies and creates a CarbonData table.</td> -<td>NO</td> -</tr> -<tr> -<td>TBLPROPERTIES</td> -<td>List of CarbonData table properties.</td> -<td>YES</td> -</tr> -</tbody> -</table> -<h3> -<a id="usage-guidelines" class="anchor" href="#usage-guidelines" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Usage Guidelines</h3> -<p>Following are the guidelines for using table properties.</p> -<ul> -<li> -<p><strong>Dictionary Encoding Configuration</strong></p> -<p>Dictionary encoding is enabled by default for all String columns, and disabled for non-String columns. You can include and exclude columns for dictionary encoding.</p> -</li> -</ul> -<pre><code> TBLPROPERTIES ('DICTIONARY_EXCLUDE'='column1, column2') - TBLPROPERTIES ('DICTIONARY_INCLUDE'='column1, column2') -</code></pre> -<p>Here, DICTIONARY_EXCLUDE will exclude dictionary creation. This is applicable for high-cardinality columns and is an optional parameter. DICTIONARY_INCLUDE will generate dictionary for the columns specified in the list.</p> -<ul> -<li> -<p><strong>Table Block Size Configuration</strong></p> -<p>The block size of table files can be defined using the property TABLE_BLOCKSIZE. It accepts only integer values. The default value is 1024 MB and supports a range of 1 MB to 2048 MB. -If you do not specify this value in the DDL command, default value is used.</p> -</li> -</ul> -<pre><code> TBLPROPERTIES ('TABLE_BLOCKSIZE'='512') -</code></pre> -<p>Here 512 MB means the block size of this table is 512 MB, you can also set it as 512M or 512.</p> -<ul> -<li> -<p><strong>Inverted Index Configuration</strong></p> -<p>Inverted index is very useful to improve compression ratio and query speed, especially for those low-cardinality columns which are in reward position. -By default inverted index is enabled. The user can disable the inverted index creation for some columns.</p> -</li> -</ul> -<pre><code> TBLPROPERTIES ('NO_INVERTED_INDEX'='column1, column3') -</code></pre> -<p>No inverted index shall be generated for the columns specified in NO_INVERTED_INDEX. This property is applicable on columns with high-cardinality and is an optional parameter.</p> -<p>NOTE:</p> -<ul> -<li> -<p>By default all columns other than numeric datatype are treated as dimensions and all columns of numeric datatype are treated as measures.</p> -</li> -<li> -<p>All dimensions except complex datatype columns are part of multi dimensional key(MDK). This behavior can be overridden by using TBLPROPERTIES. If the user wants to keep any column (except columns of complex datatype) in multi dimensional key then he can keep the columns either in DICTIONARY_EXCLUDE or DICTIONARY_INCLUDE.</p> -</li> -<li> -<p><strong>Sort Columns Configuration</strong></p> -<p>"SORT_COLUMN" property is for users to specify which columns belong to the MDK index. If user don't specify "SORT_COLUMN" property, by default MDK index be built by using all dimension columns except complex datatype column.</p> -</li> -</ul> -<pre><code> TBLPROPERTIES ('SORT_COLUMNS'='column1, column3') -</code></pre> -<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 IF NOT EXISTS productSchema.productSalesTable ( - productNumber Int, - productName String, - storeCity String, - storeProvince String, - productCategory String, - productBatch String, - saleQuantity Int, - revenue Int) - STORED BY 'carbondata' - TBLPROPERTIES ('DICTIONARY_EXCLUDE'='storeCity', - 'DICTIONARY_INCLUDE'='productNumber', - 'NO_INVERTED_INDEX'='productBatch', - 'SORT_COLUMNS'='productName,storeCity') -</code></pre> -<ul> -<li><strong>SORT_COLUMNS</strong></li> -</ul> -<pre><code>This table property specifies the order of the sort column. -</code></pre> -<pre><code> TBLPROPERTIES('SORT_COLUMNS'='column1, column3') -</code></pre> -<p>NOTE:</p> -<ul> -<li> -<p>If this property is not specified, then by default SORT_COLUMNS consist of all dimension (exclude Complex Column).</p> -</li> -<li> -<p>If this property is specified but with empty argument, then the table will be loaded without sort. For example, ('SORT_COLUMNS'='')</p> -</li> -</ul> -<h2> -<a id="show-table" class="anchor" href="#show-table" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>SHOW TABLE</h2> -<p>This command can be used to list all the tables in current database or all the tables of a specific database.</p> -<pre><code> SHOW TABLES [IN db_Name]; -</code></pre> -<h3> -<a id="parameter-description-1" class="anchor" href="#parameter-description-1" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Parameter Description</h3> -<table> -<thead> -<tr> -<th>Parameter</th> -<th>Description</th> -<th>Optional</th> -</tr> -</thead> -<tbody> -<tr> -<td>IN db_Name</td> -<td>Name of the database. Required only if tables of this specific database are to be listed.</td> -<td>YES</td> -</tr> -</tbody> -</table> -<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> SHOW TABLES IN ProductSchema; -</code></pre> -<h2> -<a id="alter-table" class="anchor" href="#alter-table" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>ALTER TABLE</h2> -<p>The following section shall discuss the commands to modify the physical or logical state of the existing table(s).</p> -<h3> -<a id="rename-table" class="anchor" href="#rename-table" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a><strong>RENAME TABLE</strong> -</h3> -<p>This command is used to rename the existing table.</p> -<pre><code> ALTER TABLE [db_name.]table_name RENAME TO new_table_name; -</code></pre> -<h4> -<a id="parameter-description-2" class="anchor" href="#parameter-description-2" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Parameter Description</h4> -<table> -<thead> -<tr> -<th>Parameter</th> -<th>Description</th> -<th>Optional</th> -</tr> -</thead> -<tbody> -<tr> -<td>db_Name</td> -<td>Name of the database. If this parameter is left unspecified, the current database is selected.</td> -<td>YES</td> -</tr> -<tr> -<td>table_name</td> -<td>Name of the existing table.</td> -<td>NO</td> -</tr> -<tr> -<td>new_table_name</td> -<td>New table name for the existing table.</td> -<td>NO</td> -</tr> -</tbody> -</table> -<h4> -<a id="usage-guidelines-1" class="anchor" href="#usage-guidelines-1" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Usage Guidelines</h4> -<ul> -<li> -<p>Queries that require the formation of path using the table name for reading carbon store files, running in parallel with Rename command might fail during the renaming operation.</p> -</li> -<li> -<p>Renaming of Secondary index table(s) is not permitted.</p> -</li> -</ul> -<h4> -<a id="examples" class="anchor" href="#examples" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Examples:</h4> -<pre><code> ALTER TABLE carbon RENAME TO carbondata; -</code></pre> -<pre><code> ALTER TABLE test_db.carbon RENAME TO test_db.carbondata; -</code></pre> -<h3> -<a id="add-column" class="anchor" href="#add-column" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a><strong>ADD COLUMN</strong> -</h3> -<p>This command is used to add a new column to the existing table.</p> -<pre><code> ALTER TABLE [db_name.]table_name ADD COLUMNS (col_name data_type,...) - TBLPROPERTIES('DICTIONARY_INCLUDE'='col_name,...', - 'DICTIONARY_EXCLUDE'='col_name,...', - 'DEFAULT.VALUE.COLUMN_NAME'='default_value'); -</code></pre> -<h4> -<a id="parameter-description-3" class="anchor" href="#parameter-description-3" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Parameter Description</h4> -<table> -<thead> -<tr> -<th>Parameter</th> -<th>Description</th> -<th>Optional</th> -</tr> -</thead> -<tbody> -<tr> -<td>db_Name</td> -<td>Name of the database. If this parameter is left unspecified, the current database is selected.</td> -<td>YES</td> -</tr> -<tr> -<td>table_name</td> -<td>Name of the existing table.</td> -<td>NO</td> -</tr> -<tr> -<td>col_name data_type</td> -<td>Name of comma-separated column with data type. Column names contain letters, digits, and underscores (_).</td> -<td>NO</td> -</tr> -</tbody> -</table> -<p>NOTE: Do not name the column after name, tupleId, PositionId, and PositionReference when creating Carbon tables because they are used internally by UPDATE, DELETE, and secondary index.</p> -<h4> -<a id="usage-guidelines-2" class="anchor" href="#usage-guidelines-2" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Usage Guidelines</h4> -<ul> -<li> -<p>Apart from DICTIONARY_INCLUDE, DICTIONARY_EXCLUDE and default_value no other property will be read. If any other property name is specified, error will not be thrown, it will be ignored.</p> -</li> -<li> -<p>If default value is not specified, then NULL will be considered as the default value for the column.</p> -</li> -<li> -<p>For addition of column, if DICTIONARY_INCLUDE and DICTIONARY_EXCLUDE are not specified, then the decision will be taken based on data type of the column.</p> -</li> -</ul> -<h4> -<a id="examples-1" class="anchor" href="#examples-1" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Examples:</h4> -<pre><code> ALTER TABLE carbon ADD COLUMNS (a1 INT, b1 STRING); -</code></pre> -<pre><code> ALTER TABLE carbon ADD COLUMNS (a1 INT, b1 STRING) - TBLPROPERTIES('DICTIONARY_EXCLUDE'='b1'); -</code></pre> -<pre><code> ALTER TABLE carbon ADD COLUMNS (a1 INT, b1 STRING) - TBLPROPERTIES('DICTIONARY_INCLUDE'='a1'); -</code></pre> -<pre><code> ALTER TABLE carbon ADD COLUMNS (a1 INT, b1 STRING) - TBLPROPERTIES('DEFAULT.VALUE.a1'='10'); -</code></pre> -<h3> -<a id="drop-columns" class="anchor" href="#drop-columns" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a><strong>DROP COLUMNS</strong> -</h3> -<p>This command is used to delete a existing column or multiple columns in a table.</p> -<pre><code> ALTER TABLE [db_name.]table_name DROP COLUMNS (col_name, ...); -</code></pre> -<h4> -<a id="parameter-description-4" class="anchor" href="#parameter-description-4" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Parameter Description</h4> -<table> -<thead> -<tr> -<th>Parameter</th> -<th>Description</th> -<th>Optional</th> -</tr> -</thead> -<tbody> -<tr> -<td>db_Name</td> -<td>Name of the database. If this parameter is left unspecified, the current database is selected.</td> -<td>YES</td> -</tr> -<tr> -<td>table_name</td> -<td>Name of the existing table.</td> -<td>NO</td> -</tr> -<tr> -<td>col_name</td> -<td>Name of comma-separated column with data type. Column names contain letters, digits, and underscores (_)</td> -<td>NO</td> -</tr> -</tbody> -</table> -<h4> -<a id="usage-guidelines-3" class="anchor" href="#usage-guidelines-3" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Usage Guidelines</h4> -<ul> -<li> -<p>Deleting a column will also clear the dictionary files, provided the column is of type dictionary.</p> -</li> -<li> -<p>For delete column operation, there should be at least one key column that exists in the schema after deletion else error message will be displayed and the operation shall fail.</p> -</li> -</ul> -<h4> -<a id="examples-2" class="anchor" href="#examples-2" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Examples:</h4> -<p>If the table contains 4 columns namely a1, b1, c1, and d1.</p> -<ul> -<li><strong>To delete a single column:</strong></li> -</ul> -<pre><code> ALTER TABLE carbon DROP COLUMNS (b1); -</code></pre> -<pre><code> ALTER TABLE test_db.carbon DROP COLUMNS (b1); -</code></pre> -<ul> -<li><strong>To delete multiple columns:</strong></li> -</ul> -<pre><code> ALTER TABLE carbon DROP COLUMNS (c1,d1); -</code></pre> -<h3> -<a id="change-data-type" class="anchor" href="#change-data-type" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a><strong>CHANGE DATA TYPE</strong> -</h3> -<p>This command is used to change the data type from INT to BIGINT or decimal precision from lower to higher.</p> -<pre><code> ALTER TABLE [db_name.]table_name - CHANGE col_name col_name changed_column_type; -</code></pre> -<h4> -<a id="parameter-description-5" class="anchor" href="#parameter-description-5" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Parameter Description</h4> -<table> -<thead> -<tr> -<th>Parameter</th> -<th>Description</th> -<th>Optional</th> -</tr> -</thead> -<tbody> -<tr> -<td>db_Name</td> -<td>Name of the database. If this parameter is left unspecified, the current database is selected.</td> -<td>YES</td> -</tr> -<tr> -<td>table_name</td> -<td>Name of the existing table.</td> -<td>NO</td> -</tr> -<tr> -<td>col_name</td> -<td>Name of comma-separated column with data type. Column names contain letters, digits, and underscores (_).</td> -<td>NO</td> -</tr> -<tr> -<td>changed_column_type</td> -<td>The change in the data type.</td> -<td>NO</td> -</tr> -</tbody> -</table> -<h4> -<a id="usage-guidelines-4" class="anchor" href="#usage-guidelines-4" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Usage Guidelines</h4> -<ul> -<li>Change of decimal data type from lower precision to higher precision will only be supported for cases where there is no data loss.</li> -</ul> -<h4> -<a id="valid-scenarios" class="anchor" href="#valid-scenarios" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Valid Scenarios</h4> -<ul> -<li> -<p>Invalid scenario - Change of decimal precision from (10,2) to (10,5) is invalid as in this case only scale is increased but total number of digits remains the same.</p> -</li> -<li> -<p>Valid scenario - Change of decimal precision from (10,2) to (12,3) is valid as the total number of digits are increased by 2 but scale is increased only by 1 which will not lead to any data loss.</p> -</li> -<li> -<p>Note :The allowed range is 38,38 (precision, scale) and is a valid upper case scenario which is not resulting in data loss.</p> -</li> -</ul> -<h4> -<a id="examples-3" class="anchor" href="#examples-3" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Examples:</h4> -<ul> -<li><strong>Changing data type of column a1 from INT to BIGINT</strong></li> -</ul> -<pre><code> ALTER TABLE test_db.carbon CHANGE a1 a1 BIGINT; -</code></pre> -<ul> -<li><strong>Changing decimal precision of column a1 from 10 to 18.</strong></li> -</ul> -<pre><code> ALTER TABLE test_db.carbon CHANGE a1 a1 DECIMAL(18,2); -</code></pre> -<h2> -<a id="drop-table" class="anchor" href="#drop-table" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>DROP TABLE</h2> -<p>This command is used to delete an existing table.</p> -<pre><code> DROP TABLE [IF EXISTS] [db_name.]table_name; -</code></pre> -<h3> -<a id="parameter-description-6" class="anchor" href="#parameter-description-6" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Parameter Description</h3> -<table> -<thead> -<tr> -<th>Parameter</th> -<th>Description</th> -<th>Optional</th> -</tr> -</thead> -<tbody> -<tr> -<td>db_Name</td> -<td>Name of the database. If not specified, current database will be selected.</td> -<td>YES</td> -</tr> -<tr> -<td>table_name</td> -<td>Name of the table to be deleted.</td> -<td>NO</td> -</tr> -</tbody> -</table> -<h3> -<a id="example-2" class="anchor" href="#example-2" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Example:</h3> -<pre><code> DROP TABLE IF EXISTS productSchema.productSalesTable; -</code></pre> -<h2> -<a id="compaction" class="anchor" href="#compaction" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>COMPACTION</h2> -<p>This command merges the specified number of segments into one segment. This enhances the query performance of the table.</p> -<pre><code> ALTER TABLE [db_name.]table_name COMPACT 'MINOR/MAJOR'; -</code></pre> -<p>To get details about Compaction refer to <a href="data-management.html">Data Management</a></p> -<h3> -<a id="parameter-description-7" class="anchor" href="#parameter-description-7" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Parameter Description</h3> -<table> -<thead> -<tr> -<th>Parameter</th> -<th>Description</th> -<th>Optional</th> -</tr> -</thead> -<tbody> -<tr> -<td>db_name</td> -<td>Database name, if it is not specified then it uses current database.</td> -<td>YES</td> -</tr> -<tr> -<td>table_name</td> -<td>The name of the table in provided database.</td> -<td>NO</td> -</tr> -</tbody> -</table> -<h3> -<a id="syntax" class="anchor" href="#syntax" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Syntax</h3> -<ul> -<li><strong>Minor Compaction</strong></li> -</ul> -<pre><code>ALTER TABLE table_name COMPACT 'MINOR'; -</code></pre> -<ul> -<li><strong>Major Compaction</strong></li> -</ul> -<pre><code>ALTER TABLE table_name COMPACT 'MAJOR'; -</code></pre> -<h2> -<a id="bucketing" class="anchor" href="#bucketing" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>BUCKETING</h2> -<p>Bucketing feature can be used to distribute/organize the table/partition data into multiple files such -that similar records are present in the same file. While creating a table, a user needs to specify the -columns to be used for bucketing and the number of buckets. For the selection of bucket the Hash value -of columns is used.</p> -<pre><code> CREATE TABLE [IF NOT EXISTS] [db_name.]table_name - [(col_name data_type, ...)] - STORED BY 'carbondata' - TBLPROPERTIES('BUCKETNUMBER'='noOfBuckets', - 'BUCKETCOLUMNS'='columnname') -</code></pre> -<h3> -<a id="parameter-description-8" class="anchor" href="#parameter-description-8" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Parameter Description</h3> -<table> -<thead> -<tr> -<th>Parameter</th> -<th>Description</th> -<th>Optional</th> -</tr> -</thead> -<tbody> -<tr> -<td>BUCKETNUMBER</td> -<td>Specifies the number of Buckets to be created.</td> -<td>No</td> -</tr> -<tr> -<td>BUCKETCOLUMNS</td> -<td>Specify the columns to be considered for Bucketing</td> -<td>No</td> -</tr> -</tbody> -</table> -<h3> -<a id="usage-guidelines-5" class="anchor" href="#usage-guidelines-5" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Usage Guidelines</h3> -<ul> -<li> -<p>The feature is supported for Spark 1.6.2 onwards, but the performance optimization is evident from Spark 2.1 onwards.</p> -</li> -<li> -<p>Bucketing can not be performed for columns of Complex Data Types.</p> -</li> -<li> -<p>Columns in the BUCKETCOLUMN parameter must be only dimension. The BUCKETCOLUMN parameter can not be a measure or a combination of measures and dimensions.</p> -</li> -</ul> -<h3> -<a id="example-3" class="anchor" href="#example-3" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Example:</h3> -<pre><code> CREATE TABLE IF NOT EXISTS productSchema.productSalesTable ( - productNumber Int, - saleQuantity Int, - productName String, - storeCity String, - storeProvince String, - productCategory String, - productBatch String, - revenue Int) - STORED BY 'carbondata' - TBLPROPERTIES ('DICTIONARY_EXCLUDE'='productName', - 'DICTIONARY_INCLUDE'='productNumber,saleQuantity', - 'NO_INVERTED_INDEX'='productBatch', - 'BUCKETNUMBER'='4', - 'BUCKETCOLUMNS'='productName') -</code></pre> -</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/dml-of-carbondata.html ---------------------------------------------------------------------- diff --git a/content/dml-of-carbondata.html b/content/dml-of-carbondata.html index ac41f7c..e658a68 100644 --- a/content/dml-of-carbondata.html +++ b/content/dml-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> @@ -250,7 +258,7 @@ OPTIONS(property_name=property_value, ...) </tr> <tr> <td><a href="#commentchar">COMMENTCHAR</a></td> -<td>Character used to comment the rows in the input csv file.Those rows will be skipped from processing</td> +<td>Character used to comment the rows in the input csv file. Those rows will be skipped from processing</td> </tr> <tr> <td><a href="#header">HEADER</a></td> @@ -289,11 +297,11 @@ OPTIONS(property_name=property_value, ...) <td>Path to read the dictionary data from for particular column</td> </tr> <tr> -<td><a href="#dateformat">DATEFORMAT</a></td> +<td><a href="#dateformattimestampformat">DATEFORMAT</a></td> <td>Format of date in the input csv file</td> </tr> <tr> -<td><a href="#timestampformat">TIMESTAMPFORMAT</a></td> +<td><a href="#dateformattimestampformat">TIMESTAMPFORMAT</a></td> <td>Format of timestamp in the input csv file</td> </tr> <tr> @@ -310,7 +318,7 @@ OPTIONS(property_name=property_value, ...) </tr> <tr> <td><a href="#bad-records-handling">BAD_RECORD_PATH</a></td> -<td>Bad records logging path.Useful when bad record logging is enabled</td> +<td>Bad records logging path. Useful when bad record logging is enabled</td> </tr> <tr> <td><a href="#bad-records-handling">BAD_RECORDS_ACTION</a></td> @@ -428,7 +436,7 @@ true: CSV file is with file header.</p> <h5> <a id="sort-column-bounds" class="anchor" href="#sort-column-bounds" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>SORT COLUMN BOUNDS:</h5> <p>Range bounds for sort columns.</p> -<p>Suppose the table is created with 'SORT_COLUMNS'='name,id' and the range for name is aaa<del>zzz, the value range for id is 0</del>1000. Then during data loading, we can specify the following option to enhance data loading performance.</p> +<p>Suppose the table is created with 'SORT_COLUMNS'='name,id' and the range for name is aaa to zzz, the value range for id is 0 to 1000. Then during data loading, we can specify the following option to enhance data loading performance.</p> <pre><code>OPTIONS('SORT_COLUMN_BOUNDS'='f,250;l,500;r,750') </code></pre> <p>Each bound is separated by ';' and each field value in bound is separated by ','. In the example above, we provide 3 bounds to distribute records to 4 partitions. The values 'f','l','r' can evenly distribute the records. Inside carbondata, for a record we compare the value of sort columns with that of the bounds and decide which partition the record will be forwarded to.</p> @@ -437,7 +445,7 @@ true: CSV file is with file header.</p> <li>SORT_COLUMN_BOUNDS will be used only when the SORT_SCOPE is 'local_sort'.</li> <li>Carbondata will use these bounds as ranges to process data concurrently during the final sort percedure. The records will be sorted and written out inside each partition. Since the partition is sorted, all records will be sorted.</li> <li>Since the actual order and literal order of the dictionary column are not necessarily the same, we do not recommend you to use this feature if the first sort column is 'dictionary_include'.</li> -<li>The option works better if your CPU usage during loading is low. If your system is already CPU tense, better not to use this option. Besides, it depends on the user to specify the bounds. If user does not know the exactly bounds to make the data distributed evenly among the bounds, loading performance will still be better than before or at least the same as before.</li> +<li>The option works better if your CPU usage during loading is low. If your current system CPU usage is high, better not to use this option. Besides, it depends on the user to specify the bounds. If user does not know the exactly bounds to make the data distributed evenly among the bounds, loading performance will still be better than before or at least the same as before.</li> <li>Users can find more information about this option in the description of PR1953.</li> </ul> </li> @@ -492,10 +500,6 @@ projectjoindate,projectenddate,attendance,utilization,salary', <li>Since Bad Records Path can be specified in create, load and carbon properties. Therefore, value specified in load will have the highest priority, and value specified in carbon properties will have the least priority.</li> </ul> -<p><strong>Bad Records Path:</strong> -This property is used to specify the location where bad records would be written.</p> -<pre><code>TBLPROPERTIES('BAD_RECORDS_PATH'='/opt/badrecords'') -</code></pre> <p>Example:</p> <pre><code>LOAD DATA INPATH 'filepath.csv' INTO TABLE tablename OPTIONS('BAD_RECORDS_LOGGER_ENABLE'='true','BAD_RECORD_PATH'='hdfs://hacluster/tmp/carbon', http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6ad7599a/content/dml-operation-on-carbondata.html ---------------------------------------------------------------------- diff --git a/content/dml-operation-on-carbondata.html b/content/dml-operation-on-carbondata.html deleted file mode 100644 index b6a5642..0000000 --- a/content/dml-operation-on-carbondata.html +++ /dev/null @@ -1,716 +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="dml-operations-on-carbondata" class="anchor" href="#dml-operations-on-carbondata" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>DML Operations on CarbonData</h1> -<p>This tutorial guides you through the data manipulation language support provided by CarbonData.</p> -<h2> -<a id="overview" class="anchor" href="#overview" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Overview</h2> -<p>The following DML operations are supported in CarbonData :</p> -<ul> -<li><a href="#load-data">LOAD DATA</a></li> -<li><a href="#insert-data-into-a-carbondata-table">INSERT DATA INTO A CARBONDATA TABLE</a></li> -<li><a href="#show-segments">SHOW SEGMENTS</a></li> -<li><a href="#delete-segment-by-id">DELETE SEGMENT BY ID</a></li> -<li><a href="#delete-segment-by-date">DELETE SEGMENT BY DATE</a></li> -<li><a href="#update-carbondata-table">UPDATE CARBONDATA TABLE</a></li> -<li><a href="#delete-records-from-carbondata-table">DELETE RECORDS FROM CARBONDATA TABLE</a></li> -</ul> -<h2> -<a id="load-data" class="anchor" href="#load-data" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>LOAD DATA</h2> -<p>This command loads the user data in raw format to the CarbonData specific data format store, this allows CarbonData to provide good performance while querying the data. -Please visit <a href="data-management.html">Data Management</a> for more details on LOAD.</p> -<h3> -<a id="syntax" class="anchor" href="#syntax" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Syntax</h3> -<pre><code>LOAD DATA [LOCAL] INPATH 'folder_path' -INTO TABLE [db_name.]table_name -OPTIONS(property_name=property_value, ...) -</code></pre> -<p>OPTIONS are not mandatory for data loading process. Inside OPTIONS user can provide either of any options like DELIMITER, QUOTECHAR, ESCAPECHAR, MULTILINE as per requirement.</p> -<p>NOTE: The path shall be canonical path.</p> -<h3> -<a id="parameter-description" class="anchor" href="#parameter-description" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Parameter Description</h3> -<table> -<thead> -<tr> -<th>Parameter</th> -<th>Description</th> -<th>Optional</th> -</tr> -</thead> -<tbody> -<tr> -<td>folder_path</td> -<td>Path of raw csv data folder or file.</td> -<td>NO</td> -</tr> -<tr> -<td>db_name</td> -<td>Database name, if it is not specified then it uses the current database.</td> -<td>YES</td> -</tr> -<tr> -<td>table_name</td> -<td>The name of the table in provided database.</td> -<td>NO</td> -</tr> -<tr> -<td>OPTIONS</td> -<td>Extra options provided to Load</td> -<td>YES</td> -</tr> -</tbody> -</table> -<h3> -<a id="usage-guidelines" class="anchor" href="#usage-guidelines" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Usage Guidelines</h3> -<p>You can use the following options to load data:</p> -<ul> -<li> -<p><strong>DELIMITER:</strong> Delimiters can be provided in the load command.</p> -<pre><code>OPTIONS('DELIMITER'=',') -</code></pre> -</li> -<li> -<p><strong>QUOTECHAR:</strong> Quote Characters can be provided in the load command.</p> -<pre><code>OPTIONS('QUOTECHAR'='"') -</code></pre> -</li> -<li> -<p><strong>COMMENTCHAR:</strong> Comment Characters can be provided in the load command if user want to comment lines.</p> -<pre><code>OPTIONS('COMMENTCHAR'='#') -</code></pre> -</li> -<li> -<p><strong>FILEHEADER:</strong> Headers can be provided in the LOAD DATA command if headers are missing in the source files.</p> -<pre><code>OPTIONS('FILEHEADER'='column1,column2') -</code></pre> -</li> -<li> -<p><strong>MULTILINE:</strong> CSV with new line character in quotes.</p> -<pre><code>OPTIONS('MULTILINE'='true') -</code></pre> -</li> -<li> -<p><strong>ESCAPECHAR:</strong> Escape char can be provided if user want strict validation of escape character on CSV.</p> -<pre><code>OPTIONS('ESCAPECHAR'='\') -</code></pre> -</li> -<li> -<p><strong>COMPLEX_DELIMITER_LEVEL_1:</strong> Split the complex type data column in a row (eg., a$b$c --> Array = {a,b,c}).</p> -<pre><code>OPTIONS('COMPLEX_DELIMITER_LEVEL_1'='$') -</code></pre> -</li> -<li> -<p><strong>COMPLEX_DELIMITER_LEVEL_2:</strong> Split the complex type nested data column in a row. Applies level_1 delimiter & applies level_2 based on complex data type (eg., a:b$c:d --> Array> = {{a,b},{c,d}}).</p> -<pre><code>OPTIONS('COMPLEX_DELIMITER_LEVEL_2'=':') -</code></pre> -</li> -<li> -<p><strong>ALL_DICTIONARY_PATH:</strong> All dictionary files path.</p> -<pre><code>OPTIONS('ALL_DICTIONARY_PATH'='/opt/alldictionary/data.dictionary') -</code></pre> -</li> -<li> -<p><strong>COLUMNDICT:</strong> Dictionary file path for specified column.</p> -<pre><code>OPTIONS('COLUMNDICT'='column1:dictionaryFilePath1, -column2:dictionaryFilePath2') -</code></pre> -<p>NOTE: ALL_DICTIONARY_PATH and COLUMNDICT can't be used together.</p> -</li> -<li> -<p><strong>DATEFORMAT:</strong> Date format for specified column.</p> -<pre><code>OPTIONS('DATEFORMAT'='column1:dateFormat1, column2:dateFormat2') -</code></pre> -<p>NOTE: Date formats are specified by date pattern strings. The date pattern letters in CarbonData are same as in JAVA. Refer to <a href="http://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html"; target=_blank>SimpleDateFormat</a>.</p> -</li> -<li> -<p><strong>SINGLE_PASS:</strong> Single Pass Loading enables single job to finish data loading with dictionary generation on the fly. It enhances performance in the scenarios where the subsequent data loading after initial load involves fewer incremental updates on the dictionary.</p> -<p>This option specifies whether to use single pass for loading data or not. By default this option is set to FALSE.</p> -<pre><code>OPTIONS('SINGLE_PASS'='TRUE') -</code></pre> -<p>Note :</p> -<ul> -<li> -<p>If this option is set to TRUE then data loading will take less time.</p> -</li> -<li> -<p>If this option is set to some invalid value other than TRUE or FALSE then it uses the default value.</p> -</li> -<li> -<p>If this option is set to TRUE, then high.cardinality.identify.enable property will be disabled during data load.</p> -</li> -</ul> -<h3> -<a id="example" class="anchor" href="#example" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Example:</h3> -</li> -</ul> -<pre><code>LOAD DATA local inpath '/opt/rawdata/data.csv' INTO table carbontable -options('DELIMITER'=',', 'QUOTECHAR'='"','COMMENTCHAR'='#', -'FILEHEADER'='empno,empname,designation,doj,workgroupcategory, - workgroupcategoryname,deptno,deptname,projectcode, - projectjoindate,projectenddate,attendance,utilization,salary', -'MULTILINE'='true','ESCAPECHAR'='\','COMPLEX_DELIMITER_LEVEL_1'='$', -'COMPLEX_DELIMITER_LEVEL_2'=':', -'ALL_DICTIONARY_PATH'='/opt/alldictionary/data.dictionary', -'SINGLE_PASS'='TRUE' -) -</code></pre> -<ul> -<li> -<p><strong>BAD RECORDS HANDLING:</strong> Methods of handling bad records are as follows:</p> -<ul> -<li> -<p>Load all of the data before dealing with the errors.</p> -</li> -<li> -<p>Clean or delete bad records before loading data or stop the loading when bad records are found.</p> -</li> -</ul> -<pre><code>OPTIONS('BAD_RECORDS_LOGGER_ENABLE'='true', 'BAD_RECORD_PATH'='hdfs://hacluster/tmp/carbon', 'BAD_RECORDS_ACTION'='REDIRECT', 'IS_EMPTY_DATA_BAD_RECORD'='false') -</code></pre> -<p>NOTE:</p> -<ul> -<li> -<p>If the REDIRECT option is used, Carbon will add all bad records in to a separate CSV file. However, this file must not be used for subsequent data loading because the content may not exactly match the source record. You are advised to cleanse the original source record for further data ingestion. This option is used to remind you which records are bad records.</p> -</li> -<li> -<p>In loaded data, if all records are bad records, the BAD_RECORDS_ACTION is invalid and the load operation fails.</p> -</li> -<li> -<p>The maximum number of characters per column is 100000. If there are more than 100000 characters in a column, data loading will fail.</p> -</li> -</ul> -</li> -</ul> -<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>LOAD DATA INPATH 'filepath.csv' -INTO TABLE tablename -OPTIONS('BAD_RECORDS_LOGGER_ENABLE'='true', -'BAD_RECORD_PATH'='hdfs://hacluster/tmp/carbon', -'BAD_RECORDS_ACTION'='REDIRECT', -'IS_EMPTY_DATA_BAD_RECORD'='false'); -</code></pre> -<p><strong>Bad Records Management Options:</strong></p> -<table> -<thead> -<tr> -<th>Options</th> -<th>Default Value</th> -<th>Description</th> -</tr> -</thead> -<tbody> -<tr> -<td>BAD_RECORDS_LOGGER_ENABLE</td> -<td>false</td> -<td>Whether to create logs with details about bad records.</td> -</tr> -<tr> -<td>BAD_RECORDS_ACTION</td> -<td>FAIL</td> -<td>Following are the four types of action for bad records: FORCE: Auto-corrects the data by storing the bad records as NULL. REDIRECT: Bad records are written to the raw CSV instead of being loaded. IGNORE: Bad records are neither loaded nor written to the raw CSV. FAIL: Data loading fails if any bad records are found. NOTE: In loaded data, if all records are bad records, the BAD_RECORDS_ACTION is invalid and the load operation fails.</td> -</tr> -<tr> -<td>IS_EMPTY_DATA_BAD_RECORD</td> -<td>false</td> -<td>If false, then empty ("" or '' or ,,) data will not be considered as bad record and vice versa.</td> -</tr> -<tr> -<td>BAD_RECORD_PATH</td> -<td>-</td> -<td>Specifies the HDFS path where bad records are stored. By default the value is Null. This path must to be configured by the user if bad record logger is enabled or bad record action redirect.</td> -</tr> -</tbody> -</table> -<h2> -<a id="insert-data-into-a-carbondata-table" class="anchor" href="#insert-data-into-a-carbondata-table" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>INSERT DATA INTO A CARBONDATA TABLE</h2> -<p>This command inserts data into a CarbonData table. It is defined as a combination of two queries Insert and Select query respectively. It inserts records from a source table into a target CarbonData table. The source table can be a Hive table, Parquet table or a CarbonData table itself. It comes with the functionality to aggregate the records of a table by performing Select query on source table and load its corresponding resultant records into a CarbonData table.</p> -<p><strong>NOTE</strong> : The client node where the INSERT command is executing, must be part of the cluster.</p> -<h3> -<a id="syntax-1" class="anchor" href="#syntax-1" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Syntax</h3> -<pre><code>INSERT INTO TABLE <CARBONDATA TABLE> SELECT * FROM sourceTableName -[ WHERE { <filter_condition> } ]; -</code></pre> -<p>You can also omit the <code>table</code> keyword and write your query as:</p> -<pre><code>INSERT INTO <CARBONDATA TABLE> SELECT * FROM sourceTableName -[ WHERE { <filter_condition> } ]; -</code></pre> -<h3> -<a id="parameter-description-1" class="anchor" href="#parameter-description-1" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Parameter Description</h3> -<table> -<thead> -<tr> -<th>Parameter</th> -<th>Description</th> -</tr> -</thead> -<tbody> -<tr> -<td>CARBON TABLE</td> -<td>The name of the Carbon table in which you want to perform the insert operation.</td> -</tr> -<tr> -<td>sourceTableName</td> -<td>The table from which the records are read and inserted into destination CarbonData table.</td> -</tr> -</tbody> -</table> -<h3> -<a id="usage-guidelines-1" class="anchor" href="#usage-guidelines-1" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Usage Guidelines</h3> -<p>The following condition must be met for successful insert operation :</p> -<ul> -<li>The source table and the CarbonData table must have the same table schema.</li> -<li>The table must be created.</li> -<li>Overwrite is not supported for CarbonData table.</li> -<li>The data type of source and destination table columns should be same, else the data from source table will be treated as bad records and the INSERT command fails.</li> -<li>INSERT INTO command does not support partial success if bad records are found, it will fail.</li> -<li>Data cannot be loaded or updated in source table while insert from source table to target table is in progress.</li> -</ul> -<p>To enable data load or update during insert operation, configure the following property to true.</p> -<pre><code>carbon.insert.persist.enable=true -</code></pre> -<p>By default the above configuration will be false.</p> -<p><strong>NOTE</strong>: Enabling this property will reduce the performance.</p> -<h3> -<a id="examples" class="anchor" href="#examples" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Examples</h3> -<pre><code>INSERT INTO table1 SELECT item1 ,sum(item2 + 1000) as result FROM -table2 group by item1; -</code></pre> -<pre><code>INSERT INTO table1 SELECT item1, item2, item3 FROM table2 -where item2='xyz'; -</code></pre> -<pre><code>INSERT INTO table1 SELECT * FROM table2 -where exists (select * from table3 -where table2.item1 = table3.item1); -</code></pre> -<p><strong>The Status Success/Failure shall be captured in the driver log.</strong></p> -<h2> -<a id="show-segments" class="anchor" href="#show-segments" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>SHOW SEGMENTS</h2> -<p>This command is used to get the segments of CarbonData table.</p> -<pre><code>SHOW SEGMENTS FOR TABLE [db_name.]table_name -LIMIT number_of_segments; -</code></pre> -<h3> -<a id="parameter-description-2" class="anchor" href="#parameter-description-2" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Parameter Description</h3> -<table> -<thead> -<tr> -<th>Parameter</th> -<th>Description</th> -<th>Optional</th> -</tr> -</thead> -<tbody> -<tr> -<td>db_name</td> -<td>Database name, if it is not specified then it uses the current database.</td> -<td>YES</td> -</tr> -<tr> -<td>table_name</td> -<td>The name of the table in provided database.</td> -<td>NO</td> -</tr> -<tr> -<td>number_of_segments</td> -<td>Limit the output to this number.</td> -<td>YES</td> -</tr> -</tbody> -</table> -<h3> -<a id="example-2" class="anchor" href="#example-2" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Example:</h3> -<pre><code>SHOW SEGMENTS FOR TABLE CarbonDatabase.CarbonTable LIMIT 4; -</code></pre> -<h2> -<a id="delete-segment-by-id" class="anchor" href="#delete-segment-by-id" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>DELETE SEGMENT BY ID</h2> -<p>This command is used to delete segment by using the segment ID. Each segment has a unique segment ID associated with it. -Using this segment ID, you can remove the segment.</p> -<p>The following command will get the segmentID.</p> -<pre><code>SHOW SEGMENTS FOR Table [db_name.]table_name LIMIT number_of_segments -</code></pre> -<p>After you retrieve the segment ID of the segment that you want to delete, execute the following command to delete the selected segment.</p> -<pre><code>DELETE FROM TABLE [db_name.]table_name WHERE SEGMENT.ID IN (segment_id1, segments_id2, ...) -</code></pre> -<h3> -<a id="parameter-description-3" class="anchor" href="#parameter-description-3" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Parameter Description</h3> -<table> -<thead> -<tr> -<th>Parameter</th> -<th>Description</th> -<th>Optional</th> -</tr> -</thead> -<tbody> -<tr> -<td>segment_id</td> -<td>Segment Id of the load.</td> -<td>NO</td> -</tr> -<tr> -<td>db_name</td> -<td>Database name, if it is not specified then it uses the current database.</td> -<td>YES</td> -</tr> -<tr> -<td>table_name</td> -<td>The name of the table in provided database.</td> -<td>NO</td> -</tr> -</tbody> -</table> -<h3> -<a id="example-3" class="anchor" href="#example-3" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Example:</h3> -<pre><code>DELETE FROM TABLE CarbonDatabase.CarbonTable WHERE SEGMENT.ID IN (0); -DELETE FROM TABLE CarbonDatabase.CarbonTable WHERE SEGMENT.ID IN (0,5,8); -</code></pre> -<p>NOTE: Here 0.1 is compacted segment sequence id.</p> -<h2> -<a id="delete-segment-by-date" class="anchor" href="#delete-segment-by-date" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>DELETE SEGMENT BY DATE</h2> -<p>This command will allow to delete the CarbonData segment(s) from the store based on the date provided by the user in the DML command. -The segment created before the particular date will be removed from the specific stores.</p> -<pre><code>DELETE FROM TABLE [db_name.]table_name -WHERE SEGMENT.STARTTIME BEFORE DATE_VALUE -</code></pre> -<h3> -<a id="parameter-description-4" class="anchor" href="#parameter-description-4" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Parameter Description</h3> -<table> -<thead> -<tr> -<th>Parameter</th> -<th>Description</th> -<th>Optional</th> -</tr> -</thead> -<tbody> -<tr> -<td>DATE_VALUE</td> -<td>Valid segment load start time value. All the segments before this specified date will be deleted.</td> -<td>NO</td> -</tr> -<tr> -<td>db_name</td> -<td>Database name, if it is not specified then it uses the current database.</td> -<td>YES</td> -</tr> -<tr> -<td>table_name</td> -<td>The name of the table in provided database.</td> -<td>NO</td> -</tr> -</tbody> -</table> -<h3> -<a id="example-4" class="anchor" href="#example-4" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Example:</h3> -<pre><code> DELETE FROM TABLE CarbonDatabase.CarbonTable - WHERE SEGMENT.STARTTIME BEFORE '2017-06-01 12:05:06'; -</code></pre> -<h2> -<a id="update-carbondata-table" class="anchor" href="#update-carbondata-table" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Update CarbonData Table</h2> -<p>This command will allow to update the carbon table based on the column expression and optional filter conditions.</p> -<h3> -<a id="syntax-2" class="anchor" href="#syntax-2" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Syntax</h3> -<pre><code> UPDATE <table_name> - SET (column_name1, column_name2, ... column_name n) = - (column1_expression , column2_expression, ... column n_expression ) - [ WHERE { <filter_condition> } ]; -</code></pre> -<p>alternatively the following the command can also be used for updating the CarbonData Table :</p> -<pre><code>UPDATE <table_name> -SET (column_name1, column_name2) = -(select sourceColumn1, sourceColumn2 from sourceTable -[ WHERE { <filter_condition> } ] ) -[ WHERE { <filter_condition> } ]; -</code></pre> -<h3> -<a id="parameter-description-5" class="anchor" href="#parameter-description-5" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Parameter Description</h3> -<table> -<thead> -<tr> -<th>Parameter</th> -<th>Description</th> -</tr> -</thead> -<tbody> -<tr> -<td>table_name</td> -<td>The name of the Carbon table in which you want to perform the update operation.</td> -</tr> -<tr> -<td>column_name</td> -<td>The destination columns to be updated.</td> -</tr> -<tr> -<td>sourceColumn</td> -<td>The source table column values to be updated in destination table.</td> -</tr> -<tr> -<td>sourceTable</td> -<td>The table from which the records are updated into destination Carbon table.</td> -</tr> -</tbody> -</table> -<p>NOTE: This functionality is currently not supported in Spark 2.x and will support soon.</p> -<h3> -<a id="usage-guidelines-2" class="anchor" href="#usage-guidelines-2" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Usage Guidelines</h3> -<p>The following conditions must be met for successful updation :</p> -<ul> -<li>The update command fails if multiple input rows in source table are matched with single row in destination table.</li> -<li>If the source table generates empty records, the update operation will complete successfully without updating the table.</li> -<li>If a source table row does not correspond to any of the existing rows in a destination table, the update operation will complete successfully without updating the table.</li> -<li>In sub-query, if the source table and the target table are same, then the update operation fails.</li> -<li>If the sub-query used in UPDATE statement contains aggregate method or group by query, then the UPDATE operation fails.</li> -</ul> -<h3> -<a id="examples-1" class="anchor" href="#examples-1" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Examples</h3> -<p>Update is not supported for queries that contain aggregate or group by.</p> -<pre><code> UPDATE t_carbn01 a - SET (a.item_type_code, a.profit) = ( SELECT b.item_type_cd, - sum(b.profit) from t_carbn01b b - WHERE item_type_cd =2 group by item_type_code); -</code></pre> -<p>Here the Update Operation fails as the query contains aggregate function sum(b.profit) and group by clause in the sub-query.</p> -<pre><code>UPDATE carbonTable1 d -SET(d.column3,d.column5 ) = (SELECT s.c33 ,s.c55 -FROM sourceTable1 s WHERE d.column1 = s.c11) -WHERE d.column1 = 'china' EXISTS( SELECT * from table3 o where o.c2 > 1); -</code></pre> -<pre><code>UPDATE carbonTable1 d SET (c3) = (SELECT s.c33 from sourceTable1 s -WHERE d.column1 = s.c11) -WHERE exists( select * from iud.other o where o.c2 > 1); -</code></pre> -<pre><code>UPDATE carbonTable1 SET (c2, c5 ) = (c2 + 1, concat(c5 , "y" )); -</code></pre> -<pre><code>UPDATE carbonTable1 d SET (c2, c5 ) = (c2 + 1, "xyx") -WHERE d.column1 = 'india'; -</code></pre> -<pre><code>UPDATE carbonTable1 d SET (c2, c5 ) = (c2 + 1, "xyx") -WHERE d.column1 = 'india' -and EXISTS( SELECT * FROM table3 o WHERE o.column2 > 1); -</code></pre> -<p><strong>The Status Success/Failure shall be captured in the driver log and the client.</strong></p> -<h2> -<a id="delete-records-from-carbondata-table" class="anchor" href="#delete-records-from-carbondata-table" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Delete Records from CarbonData Table</h2> -<p>This command allows us to delete records from CarbonData table.</p> -<h3> -<a id="syntax-3" class="anchor" href="#syntax-3" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Syntax</h3> -<pre><code>DELETE FROM table_name [WHERE expression]; -</code></pre> -<h3> -<a id="parameter-description-6" class="anchor" href="#parameter-description-6" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Parameter Description</h3> -<table> -<thead> -<tr> -<th>Parameter</th> -<th>Description</th> -</tr> -</thead> -<tbody> -<tr> -<td>table_name</td> -<td>The name of the Carbon table in which you want to perform the delete.</td> -</tr> -</tbody> -</table> -<p>NOTE: This functionality is currently not supported in Spark 2.x and will support soon.</p> -<h3> -<a id="examples-2" class="anchor" href="#examples-2" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Examples</h3> -<pre><code>DELETE FROM columncarbonTable1 d WHERE d.column1 = 'china'; -</code></pre> -<pre><code>DELETE FROM dest WHERE column1 IN ('china', 'USA'); -</code></pre> -<pre><code>DELETE FROM columncarbonTable1 -WHERE column1 IN (SELECT column11 FROM sourceTable2); -</code></pre> -<pre><code>DELETE FROM columncarbonTable1 -WHERE column1 IN (SELECT column11 FROM sourceTable2 WHERE -column1 = 'USA'); -</code></pre> -<pre><code>DELETE FROM columncarbonTable1 WHERE column2 >= 4; -</code></pre> -<p><strong>The Status Success/Failure shall be captured in the driver log and the client.</strong></p> -</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/documentation.html ---------------------------------------------------------------------- diff --git a/content/documentation.html b/content/documentation.html index 982becf..c920945 100644 --- a/content/documentation.html +++ b/content/documentation.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> @@ -215,7 +223,7 @@ <p>Apache CarbonData is a new big data file format for faster interactive query using advanced columnar storage, index, compression and encoding techniques to improve computing efficiency, which helps in speeding up queries by an order of magnitude faster over PetaBytes of data.</p> <h2> <a id="getting-started" class="anchor" href="#getting-started" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Getting Started</h2> -<p><strong>File Format Concepts:</strong> Start with the basics of understanding the <a href="./file-structure-of-carbondata.html#carbondata-file-format">CarbonData file format</a> and its <a href="./file-structure-of-carbondata.html">storage structure</a>.This will help to understand other parts of the documentation, including deployment, programming and usage guides.</p> +<p><strong>File Format Concepts:</strong> Start with the basics of understanding the <a href="./file-structure-of-carbondata.html#carbondata-file-format">CarbonData file format</a> and its <a href="./file-structure-of-carbondata.html">storage structure</a>. This will help to understand other parts of the documentation, including deployment, programming and usage guides.</p> <p><strong>Quick Start:</strong> <a href="./quick-start-guide.html#installing-and-configuring-carbondata-to-run-locally-with-spark-shell">Run an example program</a> on your local machine or <a href="https://github.com/apache/carbondata/tree/master/examples/spark2/src/main/scala/org/apache/carbondata/examples"; target=_blank>study some examples</a>.</p> <p><strong>CarbonData SQL Language Reference:</strong> CarbonData extends the Spark SQL language and adds several <a href="./ddl-of-carbondata.html">DDL</a> and <a href="./dml-of-carbondata.html">DML</a> statements to support operations on it.Refer to the <a href="./language-manual.html">Reference Manual</a> to understand the supported features and functions.</p> <p><strong>Programming Guides:</strong> You can read our guides about <a href="./sdk-guide.html">APIs supported</a> to learn how to integrate CarbonData with your applications.</p> http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6ad7599a/content/faq.html ---------------------------------------------------------------------- diff --git a/content/faq.html b/content/faq.html index c37284f..aac986c 100644 --- a/content/faq.html +++ b/content/faq.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> @@ -224,6 +232,7 @@ <li><a href="#why-aggregate-query-is-not-fetching-data-from-aggregate-table">Why aggregate query is not fetching data from aggregate table?</a></li> <li><a href="#why-all-executors-are-showing-success-in-spark-ui-even-after-dataload-command-failed-at-driver-side">Why all executors are showing success in Spark UI even after Dataload command failed at Driver side?</a></li> <li><a href="#why-different-time-zone-result-for-select-query-output-when-query-sdk-writer-output">Why different time zone result for select query output when query SDK writer output?</a></li> +<li><a href="#how-to-check-lru-cache-memory-footprint">How to check LRU cache memory footprint?</a></li> </ul> <h1> <a id="troubleshooting" class="anchor" href="#troubleshooting" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>TroubleShooting</h1> @@ -252,12 +261,12 @@ By default <strong>carbon.badRecords.location</strong> specifies the following l <a id="how-to-enable-bad-record-logging" class="anchor" href="#how-to-enable-bad-record-logging" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>How to enable Bad Record Logging?</h2> <p>While loading data we can specify the approach to handle Bad Records. In order to analyse the cause of the Bad Records the parameter <code>BAD_RECORDS_LOGGER_ENABLE</code> must be set to value <code>TRUE</code>. There are multiple approaches to handle Bad Records which can be specified by the parameter <code>BAD_RECORDS_ACTION</code>.</p> <ul> -<li>To pad the incorrect values of the csv rows with NULL value and load the data in CarbonData, set the following in the query :</li> +<li>To pass the incorrect values of the csv rows with NULL value and load the data in CarbonData, set the following in the query :</li> </ul> <pre><code>'BAD_RECORDS_ACTION'='FORCE' </code></pre> <ul> -<li>To write the Bad Records without padding incorrect values with NULL in the raw csv (set in the parameter <strong>carbon.badRecords.location</strong>), set the following in the query :</li> +<li>To write the Bad Records without passing incorrect values with NULL in the raw csv (set in the parameter <strong>carbon.badRecords.location</strong>), set the following in the query :</li> </ul> <pre><code>'BAD_RECORDS_ACTION'='REDIRECT' </code></pre> @@ -367,7 +376,7 @@ select cntry,sum(gdp) from gdp21,pop1 where cntry=ctry group by cntry; </code></pre> <h2> <a id="why-all-executors-are-showing-success-in-spark-ui-even-after-dataload-command-failed-at-driver-side" class="anchor" href="#why-all-executors-are-showing-success-in-spark-ui-even-after-dataload-command-failed-at-driver-side" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Why all executors are showing success in Spark UI even after Dataload command failed at Driver side?</h2> -<p>Spark executor shows task as failed after the maximum number of retry attempts, but loading the data having bad records and BAD_RECORDS_ACTION (carbon.bad.records.action) is set as ?FAIL? will attempt only once but will send the signal to driver as failed instead of throwing the exception to retry, as there is no point to retry if bad record found and BAD_RECORDS_ACTION is set to fail. Hence the Spark executor displays this one attempt as successful but the command has actually failed to execute. Task attempts or executor logs can be checked to observe the failure reason.</p> +<p>Spark executor shows task as failed after the maximum number of retry attempts, but loading the data having bad records and BAD_RECORDS_ACTION (carbon.bad.records.action) is set as "FAIL" will attempt only once but will send the signal to driver as failed instead of throwing the exception to retry, as there is no point to retry if bad record found and BAD_RECORDS_ACTION is set to fail. Hence the Spark executor displays this one attempt as successful but the command has actually failed to execute. Task attempts or executor logs can be checked to observe the failure reason.</p> <h2> <a id="why-different-time-zone-result-for-select-query-output-when-query-sdk-writer-output" class="anchor" href="#why-different-time-zone-result-for-select-query-output-when-query-sdk-writer-output" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Why different time zone result for select query output when query SDK writer output?</h2> <p>SDK writer is an independent entity, hence SDK writer can generate carbondata files from a non-cluster machine that has different time zones. But at cluster when those files are read, it always takes cluster time-zone. Hence, the value of timestamp and date datatype fields are not original value. @@ -379,6 +388,20 @@ If wanted to control timezone of data while writing, then set cluster's time-zon TimeZone.setDefault(TimeZone.getTimeZone("Asia/Shanghai")) </code></pre> <h2> +<a id="how-to-check-lru-cache-memory-footprint" class="anchor" href="#how-to-check-lru-cache-memory-footprint" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>How to check LRU cache memory footprint?</h2> +<p>To observe the LRU cache memory footprint in the logs, configure the below properties in log4j.properties file.</p> +<pre><code>log4j.logger.org.apache.carbondata.core.memory.UnsafeMemoryManager = DEBUG +log4j.logger.org.apache.carbondata.core.cache.CarbonLRUCache = DEBUG +</code></pre> +<p>These properties will enable the DEBUG log for the CarbonLRUCache and UnsafeMemoryManager which will print the information of memory consumed using which the LRU cache size can be decided. <strong>Note:</strong> Enabling the DEBUG log will degrade the query performance.</p> +<p><strong>Example:</strong></p> +<pre><code>18/09/26 15:05:28 DEBUG UnsafeMemoryManager: pool-44-thread-1 Memory block (org.apache.carbondata.core.memory.MemoryBlock@21312095) is created with size 10. Total memory used 413Bytes, left 536870499Bytes +18/09/26 15:05:29 DEBUG CarbonLRUCache: main Required size for entry /home/target/store/default/stored_as_carbondata_table/Fact/Part0/Segment_0/0_1537954529044.carbonindexmerge :: 181 Current cache size :: 0 +18/09/26 15:05:30 DEBUG UnsafeMemoryManager: main Freeing memory of size: 105available memory: 536870836 +18/09/26 15:05:30 DEBUG UnsafeMemoryManager: main Freeing memory of size: 76available memory: 536870912 +18/09/26 15:05:30 INFO CarbonLRUCache: main Removed entry from InMemory lru cache :: /home/target/store/default/stored_as_carbondata_table/Fact/Part0/Segment_0/0_1537954529044.carbonindexmerge +</code></pre> +<h2> <a id="getting-tablestatuslock-issues-when-loading-data" class="anchor" href="#getting-tablestatuslock-issues-when-loading-data" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Getting tablestatus.lock issues When loading data</h2> <p><strong>Symptom</strong></p> <pre><code>17/11/11 16:48:13 ERROR LocalFileLock: main hdfs:/localhost:9000/carbon/store/default/hdfstable/tablestatus.lock (No such file or directory)
