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:14:49 UTC
[01/20] carbondata-site git commit: modified for 1.5.0 version
Repository: carbondata-site
Updated Branches:
refs/heads/asf-site bee563340 -> 6f8949f11
http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6ad7599a/src/site/markdown/sdk-guide.md
----------------------------------------------------------------------
diff --git a/src/site/markdown/sdk-guide.md b/src/site/markdown/sdk-guide.md
index d786406..be42b3f 100644
--- a/src/site/markdown/sdk-guide.md
+++ b/src/site/markdown/sdk-guide.md
@@ -67,9 +67,9 @@ These SDK writer output contains just a carbondata and carbonindex files. No met
CarbonProperties.getInstance().addProperty("enable.offheap.sort", enableOffheap);
- CarbonWriterBuilder builder = CarbonWriter.builder().outputPath(path);
+ CarbonWriterBuilder builder = CarbonWriter.builder().outputPath(path).withCsvInput(schema);
- CarbonWriter writer = builder.buildWriterForCSVInput(schema);
+ CarbonWriter writer = builder.build();
int rows = 5;
for (int i = 0; i < rows; i++) {
@@ -124,7 +124,7 @@ public class TestSdkAvro {
try {
CarbonWriter writer = CarbonWriter.builder()
.outputPath(path)
- .buildWriterForAvroInput(new org.apache.avro.Schema.Parser().parse(avroSchema));
+ .withAvroInput(new org.apache.avro.Schema.Parser().parse(avroSchema)).build();
for (int i = 0; i < 100; i++) {
writer.write(record);
@@ -164,10 +164,10 @@ public class TestSdkJson {
Schema CarbonSchema = new Schema(fields);
- CarbonWriterBuilder builder = CarbonWriter.builder().outputPath(path);
+ CarbonWriterBuilder builder = CarbonWriter.builder().outputPath(path).withJsonInput(CarbonSchema);
// initialize json writer with carbon schema
- CarbonWriter writer = builder.buildWriterForJsonInput(CarbonSchema);
+ CarbonWriter writer = builder.build();
// one row of json Data as String
String JsonRow = "{\"name\":\"abcd\", \"age\":10}";
@@ -181,23 +181,34 @@ public class TestSdkJson {
```
## Datatypes Mapping
-Each of SQL data types are mapped into data types of SDK. Following are the mapping:
-
-| SQL DataTypes | Mapped SDK DataTypes |
-|---------------|----------------------|
-| BOOLEAN | DataTypes.BOOLEAN |
-| SMALLINT | DataTypes.SHORT |
-| INTEGER | DataTypes.INT |
-| BIGINT | DataTypes.LONG |
-| DOUBLE | DataTypes.DOUBLE |
-| VARCHAR | DataTypes.STRING |
-| DATE | DataTypes.DATE |
-| TIMESTAMP | DataTypes.TIMESTAMP |
-| STRING | DataTypes.STRING |
-| DECIMAL | DataTypes.createDecimalType(precision, scale) |
+Each of SQL data types and Avro Data Types are mapped into data types of SDK. Following are the mapping:
+
+| SQL DataTypes | Avro DataTypes | Mapped SDK DataTypes |
+|---------------|----------------|----------------------|
+| BOOLEAN | BOOLEAN | DataTypes.BOOLEAN |
+| SMALLINT | - | DataTypes.SHORT |
+| INTEGER | INTEGER | DataTypes.INT |
+| BIGINT | LONG | DataTypes.LONG |
+| DOUBLE | DOUBLE | DataTypes.DOUBLE |
+| VARCHAR | - | DataTypes.STRING |
+| FLOAT | FLOAT | DataTypes.FLOAT |
+| BYTE | - | DataTypes.BYTE |
+| DATE | DATE | DataTypes.DATE |
+| TIMESTAMP | - | DataTypes.TIMESTAMP |
+| STRING | STRING | DataTypes.STRING |
+| DECIMAL | DECIMAL | DataTypes.createDecimalType(precision, scale) |
+| ARRAY | ARRAY | DataTypes.createArrayType(elementType) |
+| STRUCT | RECORD | DataTypes.createStructType(fields) |
+| - | ENUM | DataTypes.STRING |
+| - | UNION | DataTypes.createStructType(types) |
+| - | MAP | DataTypes.createMapType(keyType, valueType) |
+| - | TimeMillis | DataTypes.INT |
+| - | TimeMicros | DataTypes.LONG |
+| - | TimestampMillis | DataTypes.TIMESTAMP |
+| - | TimestampMicros | DataTypes.TIMESTAMP |
**NOTE:**
- Carbon Supports below logical types of AVRO.
+ 1. Carbon Supports below logical types of AVRO.
a. Date
The date logical type represents a date within the calendar, with no reference to a particular time zone or time of day.
A date logical type annotates an Avro int, where the int stores the number of days from the unix epoch, 1 January 1970 (ISO calendar).
@@ -207,10 +218,22 @@ Each of SQL data types are mapped into data types of SDK. Following are the mapp
c. Timestamp (microsecond precision)
The timestamp-micros logical type represents an instant on the global timeline, independent of a particular time zone or calendar, with a precision of one microsecond.
A timestamp-micros logical type annotates an Avro long, where the long stores the number of microseconds from the unix epoch, 1 January 1970 00:00:00.000000 UTC.
+ d. Decimal
+ The decimal logical type represents an arbitrary-precision signed decimal number of the form unscaled × 10-scale.
+ A decimal logical type annotates Avro bytes or fixed types. The byte array must contain the two's-complement representation of the unscaled integer value in big-endian byte order. The scale is fixed, and is specified using an attribute.
+ e. Time (millisecond precision)
+ The time-millis logical type represents a time of day, with no reference to a particular calendar, time zone or date, with a precision of one millisecond.
+ A time-millis logical type annotates an Avro int, where the int stores the number of milliseconds after midnight, 00:00:00.000.
+ f. Time (microsecond precision)
+ The time-micros logical type represents a time of day, with no reference to a particular calendar, time zone or date, with a precision of one microsecond.
+ A time-micros logical type annotates an Avro long, where the long stores the number of microseconds after midnight, 00:00:00.000000.
+
Currently the values of logical types are not validated by carbon.
- Expect that avro record passed by the user is already validated by avro record generator tools.
-
+ Expect that avro record passed by the user is already validated by avro record generator tools.
+ 2. If the string data is more than 32K in length, use withTableProperties() with "long_string_columns" property
+ or directly use DataTypes.VARCHAR if it is carbon schema.
+ 3. Avro Bytes, Fixed and Duration data types are not yet supported.
## Run SQL on files directly
Instead of creating table and query it, you can also query that file directly with SQL.
@@ -234,20 +257,6 @@ public CarbonWriterBuilder outputPath(String path);
```
/**
-* If set false, writes the carbondata and carbonindex files in a flat folder structure
-* @param isTransactionalTable is a boolelan value
-* if set to false, then writes the carbondata and carbonindex files
-* in a flat folder structure.
-* if set to true, then writes the carbondata and carbonindex files
-* in segment folder structure..
-* By default set to false.
-* @return updated CarbonWriterBuilder
-*/
-public CarbonWriterBuilder isTransactionalTable(boolean isTransactionalTable);
-```
-
-```
-/**
* to set the timestamp in the carbondata and carbonindex index files
* @param UUID is a timestamp to be used in the carbondata and carbonindex index files.
* By default set to zero.
@@ -306,16 +315,6 @@ public CarbonWriterBuilder sortBy(String[] sortColumns);
```
/**
-* If set, create a schema file in metadata folder.
-* @param persist is a boolean value, If set to true, creates a schema file in metadata folder.
-* By default set to false. will not create metadata folder
-* @return updated CarbonWriterBuilder
-*/
-public CarbonWriterBuilder persistSchemaFile(boolean persist);
-```
-
-```
-/**
* sets the taskNo for the writer. SDKs concurrently running
* will set taskNo in order to avoid conflicts in file's name during write.
* @param taskNo is the TaskNo user wants to specify.
@@ -339,7 +338,7 @@ public CarbonWriterBuilder taskNo(long taskNo);
* g. complex_delimiter_level_2 -- value to Split the nested complexTypeData
* h. quotechar
* i. escapechar
-*
+*
* Default values are as follows.
*
* a. bad_records_logger_enable -- "false"
@@ -359,99 +358,88 @@ public CarbonWriterBuilder withLoadOptions(Map<String, String> options);
```
/**
- * To support the table properties for sdk writer
- *
- * @param options key,value pair of create table properties.
- * supported keys values are
- * a. blocksize -- [1-2048] values in MB. Default value is 1024
- * b. blockletsize -- values in MB. Default value is 64 MB
- * c. localDictionaryThreshold -- positive value, default is 10000
- * d. enableLocalDictionary -- true / false. Default is false
- * e. sortcolumns -- comma separated column. "c1,c2". Default all dimensions are sorted.
- *
- * @return updated CarbonWriterBuilder
- */
+* To support the table properties for sdk writer
+*
+* @param options key,value pair of create table properties.
+* supported keys values are
+* a. table_blocksize -- [1-2048] values in MB. Default value is 1024
+* b. table_blocklet_size -- values in MB. Default value is 64 MB
+* c. local_dictionary_threshold -- positive value, default is 10000
+* d. local_dictionary_enable -- true / false. Default is false
+* e. sort_columns -- comma separated column. "c1,c2". Default all dimensions are sorted.
+ If empty string "" is passed. No columns are sorted
+* j. sort_scope -- "local_sort", "no_sort", "batch_sort". default value is "local_sort"
+* k. long_string_columns -- comma separated string columns which are more than 32k length.
+* default value is null.
+*
+* @return updated CarbonWriterBuilder
+*/
public CarbonWriterBuilder withTableProperties(Map<String, String> options);
```
-
```
/**
-* this writer is not thread safe, use buildThreadSafeWriterForCSVInput in multi thread environment
-* Build a {@link CarbonWriter}, which accepts row in CSV format object
-* @param schema carbon Schema object {org.apache.carbondata.sdk.file.Schema}
-* @return CSVCarbonWriter
-* @throws IOException
-* @throws InvalidLoadOptionException
+* To make sdk writer thread safe.
+*
+* @param numOfThreads should number of threads in which writer is called in multi-thread scenario
+* default sdk writer is not thread safe.
+* can use one writer instance in one thread only.
+* @return updated CarbonWriterBuilder
*/
-public CarbonWriter buildWriterForCSVInput(org.apache.carbondata.sdk.file.Schema schema) throws IOException, InvalidLoadOptionException;
+public CarbonWriterBuilder withThreadSafe(short numOfThreads);
```
```
/**
-* Can use this writer in multi-thread instance.
-* Build a {@link CarbonWriter}, which accepts row in CSV format
-* @param schema carbon Schema object {org.apache.carbondata.sdk.file.Schema}
-* @param numOfThreads number of threads() in which .write will be called.
-* @return CSVCarbonWriter
-* @throws IOException
-* @throws InvalidLoadOptionException
+* To support hadoop configuration
+*
+* @param conf hadoop configuration support, can set s3a AK,SK,end point and other conf with this
+* @return updated CarbonWriterBuilder
*/
-public CarbonWriter buildThreadSafeWriterForCSVInput(Schema schema, short numOfThreads)
- throws IOException, InvalidLoadOptionException;
+public CarbonWriterBuilder withHadoopConf(Configuration conf)
```
-
-```
+```
/**
-* this writer is not thread safe, use buildThreadSafeWriterForAvroInput in multi thread environment
-* Build a {@link CarbonWriter}, which accepts Avro format object
-* @param avroSchema avro Schema object {org.apache.avro.Schema}
-* @return AvroCarbonWriter
-* @throws IOException
-* @throws InvalidLoadOptionException
+* to build a {@link CarbonWriter}, which accepts row in CSV format
+*
+* @param schema carbon Schema object {org.apache.carbondata.sdk.file.Schema}
+* @return CarbonWriterBuilder
*/
-public CarbonWriter buildWriterForAvroInput(org.apache.avro.Schema schema) throws IOException, InvalidLoadOptionException;
+public CarbonWriterBuilder withCsvInput(Schema schema);
```
```
/**
-* Can use this writer in multi-thread instance.
-* Build a {@link CarbonWriter}, which accepts Avro object
+* to build a {@link CarbonWriter}, which accepts Avro object
+*
* @param avroSchema avro Schema object {org.apache.avro.Schema}
-* @param numOfThreads number of threads() in which .write will be called.
-* @return AvroCarbonWriter
-* @throws IOException
-* @throws InvalidLoadOptionException
+* @return CarbonWriterBuilder
*/
-public CarbonWriter buildThreadSafeWriterForAvroInput(org.apache.avro.Schema avroSchema, short numOfThreads)
- throws IOException, InvalidLoadOptionException
+public CarbonWriterBuilder withAvroInput(org.apache.avro.Schema avroSchema);
```
-
```
/**
-* this writer is not thread safe, use buildThreadSafeWriterForJsonInput in multi thread environment
-* Build a {@link CarbonWriter}, which accepts Json object
+* to build a {@link CarbonWriter}, which accepts Json object
+*
* @param carbonSchema carbon Schema object
-* @return JsonCarbonWriter
-* @throws IOException
-* @throws InvalidLoadOptionException
+* @return CarbonWriterBuilder
*/
-public JsonCarbonWriter buildWriterForJsonInput(Schema carbonSchema);
+public CarbonWriterBuilder withJsonInput(Schema carbonSchema);
```
```
/**
-* Can use this writer in multi-thread instance.
-* Build a {@link CarbonWriter}, which accepts Json object
-* @param carbonSchema carbon Schema object
-* @param numOfThreads number of threads() in which .write will be called.
-* @return JsonCarbonWriter
+* Build a {@link CarbonWriter}
+* This writer is not thread safe,
+* use withThreadSafe() configuration in multi thread environment
+*
+* @return CarbonWriter {AvroCarbonWriter/CSVCarbonWriter/JsonCarbonWriter based on Input Type }
* @throws IOException
* @throws InvalidLoadOptionException
*/
-public JsonCarbonWriter buildThreadSafeWriterForJsonInput(Schema carbonSchema, short numOfThreads)
+public CarbonWriter build() throws IOException, InvalidLoadOptionException;
```
### Class org.apache.carbondata.sdk.file.CarbonWriter
@@ -462,7 +450,6 @@ public JsonCarbonWriter buildThreadSafeWriterForJsonInput(Schema carbonSchema, s
* which is one row of data.
* If CSVCarbonWriter, object is of type String[], which is one row of data
* If JsonCarbonWriter, object is of type String, which is one row of json
-* Note: This API is not thread safe if writer is not built with number of threads argument.
* @param object
* @throws IOException
*/
@@ -636,19 +623,6 @@ Find example code at [CarbonReaderExample](https://github.com/apache/carbondata/
```
```
- /**
- * Configure the transactional status of table
- * If set to false, then reads the carbondata and carbonindex files from a flat folder structure.
- * If set to true, then reads the carbondata and carbonindex files from segment folder structure.
- * Default value is false
- *
- * @param isTransactionalTable whether is transactional table or not
- * @return CarbonReaderBuilder object
- */
- public CarbonReaderBuilder isTransactionalTable(boolean isTransactionalTable);
-```
-
-```
/**
* Configure the filter expression for carbon reader
*
@@ -659,66 +633,13 @@ Find example code at [CarbonReaderExample](https://github.com/apache/carbondata/
```
```
- /**
- * Set the access key for S3
- *
- * @param key the string of access key for different S3 type,like: fs.s3a.access.key
- * @param value the value of access key
- * @return CarbonWriterBuilder
- */
- public CarbonReaderBuilder setAccessKey(String key, String value);
-```
-
-```
- /**
- * Set the access key for S3.
- *
- * @param value the value of access key
- * @return CarbonWriterBuilder object
- */
- public CarbonReaderBuilder setAccessKey(String value);
-```
-
-```
- /**
- * Set the secret key for S3
- *
- * @param key the string of secret key for different S3 type,like: fs.s3a.secret.key
- * @param value the value of secret key
- * @return CarbonWriterBuilder object
- */
- public CarbonReaderBuilder setSecretKey(String key, String value);
-```
-
-```
- /**
- * Set the secret key for S3
- *
- * @param value the value of secret key
- * @return CarbonWriterBuilder object
- */
- public CarbonReaderBuilder setSecretKey(String value);
-```
-
-```
- /**
- * Set the endpoint for S3
- *
- * @param key the string of endpoint for different S3 type,like: fs.s3a.endpoint
- * @param value the value of endpoint
- * @return CarbonWriterBuilder object
- */
- public CarbonReaderBuilder setEndPoint(String key, String value);
-```
-
-```
- /**
- * Set the endpoint for S3
- *
- * @param value the value of endpoint
- * @return CarbonWriterBuilder object
- */
- public CarbonReaderBuilder setEndPoint(String value);
+/**
+ * To support hadoop configuration
+ *
+ * @param conf hadoop configuration support, can set s3a AK,SK,end point and other conf with this
+ * @return updated CarbonReaderBuilder
+ */
+ public CarbonReaderBuilder withHadoopConf(Configuration conf);
```
```
http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6ad7599a/src/site/markdown/streaming-guide.md
----------------------------------------------------------------------
diff --git a/src/site/markdown/streaming-guide.md b/src/site/markdown/streaming-guide.md
index 3b71662..714b07a 100644
--- a/src/site/markdown/streaming-guide.md
+++ b/src/site/markdown/streaming-guide.md
@@ -157,7 +157,7 @@ ALTER TABLE streaming_table SET TBLPROPERTIES('streaming'='true')
At the begin of streaming ingestion, the system will try to acquire the table level lock of streaming.lock file. If the system isn't able to acquire the lock of this table, it will throw an InterruptedException.
## Create streaming segment
-The input data of streaming will be ingested into a segment of the CarbonData table, the status of this segment is streaming. CarbonData call it a streaming segment. The "tablestatus" file will record the segment status and data size. The user can use “SHOW SEGMENTS FOR TABLE tableName” to check segment status.
+The streaming data will be ingested into a separate segment of carbondata table, this segment is termed as streaming segment. The status of this segment will be recorded as "streaming" in "tablestatus" file along with its data size. You can use "SHOW SEGMENTS FOR TABLE tableName" to check segment status.
After the streaming segment reaches the max size, CarbonData will change the segment status to "streaming finish" from "streaming", and create new "streaming" segment to continue to ingest streaming data.
@@ -304,8 +304,9 @@ Following example shows how to start a streaming ingest job
| register TIMESTAMP,
| updated TIMESTAMP
|)
- |STORED BY carbondata
+ |STORED AS carbondata
|TBLPROPERTIES (
+ | 'streaming'='source',
| 'format'='csv',
| 'path'='$csvDataDir'
|)
@@ -324,7 +325,7 @@ Following example shows how to start a streaming ingest job
| register TIMESTAMP,
| updated TIMESTAMP
|)
- |STORED BY carbondata
+ |STORED AS carbondata
|TBLPROPERTIES (
| 'streaming'='true'
|)
@@ -351,7 +352,7 @@ Following example shows how to start a streaming ingest job
In above example, two table is created: source and sink. The `source` table's format is `csv` and `sink` table format is `carbon`. Then a streaming job is created to stream data from source table to sink table.
-These two tables are normal carbon table, they can be queried independently.
+These two tables are normal carbon tables, they can be queried independently.
@@ -378,11 +379,14 @@ When this is issued, carbon will start a structured streaming job to do the stre
name STRING,
age INT
)
- STORED BY carbondata
+ STORED AS carbondata
TBLPROPERTIES(
- 'format'='socket',
- 'host'='localhost',
- 'port'='8888'
+ 'streaming'='source',
+ 'format'='socket',
+ 'host'='localhost',
+ 'port'='8888',
+ 'record_format'='csv', // can be csv or json, default is csv
+ 'delimiter'='|'
)
```
@@ -394,14 +398,31 @@ When this is issued, carbon will start a structured streaming job to do the stre
.format("socket")
.option("host", "localhost")
.option("port", "8888")
+ .option("delimiter", "|")
```
- The sink table should have a TBLPROPERTY `'streaming'` equal to `true`, indicating it is a streaming table.
- In the given STMPROPERTIES, user must specify `'trigger'`, its value must be `ProcessingTime` (In future, other value will be supported). User should also specify interval value for the streaming job.
-- If the schema specifid in sink table is different from CTAS, the streaming job will fail
+- If the schema specified in sink table is different from CTAS, the streaming job will fail
+For Kafka data source, create the source table by:
+ ```SQL
+ CREATE TABLE source(
+ name STRING,
+ age INT
+ )
+ STORED AS carbondata
+ TBLPROPERTIES(
+ 'streaming'='source',
+ 'format'='kafka',
+ 'kafka.bootstrap.servers'='kafkaserver:9092',
+ 'subscribe'='test'
+ 'record_format'='csv', // can be csv or json, default is csv
+ 'delimiter'='|'
+ )
+ ```
##### STOP STREAM
http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6ad7599a/src/site/markdown/supported-data-types-in-carbondata.md
----------------------------------------------------------------------
diff --git a/src/site/markdown/supported-data-types-in-carbondata.md b/src/site/markdown/supported-data-types-in-carbondata.md
index fee80f6..daf1acf 100644
--- a/src/site/markdown/supported-data-types-in-carbondata.md
+++ b/src/site/markdown/supported-data-types-in-carbondata.md
@@ -25,6 +25,10 @@
* BIGINT
* DOUBLE
* DECIMAL
+ * FLOAT
+ * BYTE
+
+ **NOTE**: Float and Bytes are only supported for SDK and FileFormat.
* Date/Time Types
* TIMESTAMP
@@ -41,6 +45,7 @@
* Complex Types
* arrays: ARRAY``<data_type>``
* structs: STRUCT``<col_name : data_type COMMENT col_comment, ...>``
+ * maps: MAP``<primitive_type, data_type>``
**NOTE**: Only 2 level complex type schema is supported for now.
http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6ad7599a/src/site/markdown/usecases.md
----------------------------------------------------------------------
diff --git a/src/site/markdown/usecases.md b/src/site/markdown/usecases.md
index 277c455..e8b98b5 100644
--- a/src/site/markdown/usecases.md
+++ b/src/site/markdown/usecases.md
@@ -39,7 +39,7 @@ These use cases can be broadly classified into below categories:
### Scenario
-User wants to analyse all the CHR(Call History Record) and MR(Measurement Records) of the mobile subscribers in order to identify the service failures within 10 secs.Also user wants to run machine learning models on the data to fairly estimate the reasons and time of probable failures and take action ahead to meet the SLA(Service Level Agreements) of VIP customers.
+User wants to analyse all the CHR(Call History Record) and MR(Measurement Records) of the mobile subscribers in order to identify the service failures within 10 secs. Also user wants to run machine learning models on the data to fairly estimate the reasons and time of probable failures and take action ahead to meet the SLA(Service Level Agreements) of VIP customers.
### Challenges
@@ -54,7 +54,7 @@ Setup a Hadoop + Spark + CarbonData cluster managed by YARN.
Proposed the following configurations for CarbonData.(These tunings were proposed before CarbonData introduced SORT_COLUMNS parameter using which the sort order and schema order could be different.)
-Add the frequently used columns to the left of the table definition.Add it in the increasing order of cardinality.It was suggested to keep msisdn,imsi columns in the beginning of the schema.With latest CarbonData, SORT_COLUMNS needs to be configured msisdn,imsi in the beginning.
+Add the frequently used columns to the left of the table definition. Add it in the increasing order of cardinality. It was suggested to keep msisdn,imsi columns in the beginning of the schema. With latest CarbonData, SORT_COLUMNS needs to be configured msisdn,imsi in the beginning.
Add timestamp column to the right of the schema as it is naturally increasing.
@@ -71,7 +71,7 @@ Apart from these, the following CarbonData configuration was suggested to be con
| Data Loading | carbon.sort.size | 100000 | Number of records to sort at a time.More number of records configured will lead to increased memory foot print |
| Data Loading | table_blocksize | 256 | To efficiently schedule multiple tasks during query |
| Data Loading | carbon.sort.intermediate.files.limit | 100 | Increased to 100 as number of cores are more.Can perform merging in backgorund.If less number of files to merge, sort threads would be idle |
-| Data Loading | carbon.use.local.dir | TRUE | yarn application directory will be usually on a single disk.YARN would be configured with multiple disks to be used as temp or to assign randomly to applications.Using the yarn temp directory will allow carbon to use multiple disks and improve IO performance |
+| Data Loading | carbon.use.local.dir | TRUE | yarn application directory will be usually on a single disk.YARN would be configured with multiple disks to be used as temp or to assign randomly to applications. Using the yarn temp directory will allow carbon to use multiple disks and improve IO performance |
| Data Loading | carbon.use.multiple.temp.dir | TRUE | multiple disks to write sort files will lead to better IO and reduce the IO bottleneck |
| Compaction | carbon.compaction.level.threshold | 6,6 | Since frequent small loads, compacting more segments will give better query results |
| Compaction | carbon.enable.auto.load.merge | true | Since data loading is small,auto compacting keeps the number of segments less and also compaction can complete in time |
@@ -94,7 +94,7 @@ Apart from these, the following CarbonData configuration was suggested to be con
### Scenario
-User wants to analyse the person/vehicle movement and behavior during a certain time period.This output data needs to be joined with a external table for Human details extraction.The query will be run with different time period as filter to identify potential behavior mismatch.
+User wants to analyse the person/vehicle movement and behavior during a certain time period. This output data needs to be joined with a external table for Human details extraction. The query will be run with different time period as filter to identify potential behavior mismatch.
### Challenges
@@ -119,24 +119,24 @@ Use all columns are no-dictionary as the cardinality is high.
| Configuration for | Parameter | Value | Description |
| ------------------| --------------------------------------- | ----------------------- | ------------------|
| Data Loading | carbon.graph.rowset.size | 100000 | Based on the size of each row, this determines the memory required during data loading.Higher value leads to increased memory foot print |
-| Data Loading | enable.unsafe.sort | TRUE | Temporary data generated during sort is huge which causes GC bottlenecks.Using unsafe reduces the pressure on GC |
-| Data Loading | enable.offheap.sort | TRUE | Temporary data generated during sort is huge which causes GC bottlenecks.Using offheap reduces the pressure on GC.offheap can be accessed through java unsafe.hence enable.unsafe.sort needs to be true |
+| Data Loading | enable.unsafe.sort | TRUE | Temporary data generated during sort is huge which causes GC bottlenecks. Using unsafe reduces the pressure on GC |
+| Data Loading | enable.offheap.sort | TRUE | Temporary data generated during sort is huge which causes GC bottlenecks. Using offheap reduces the pressure on GC.offheap can be accessed through java unsafe.hence enable.unsafe.sort needs to be true |
| Data Loading | offheap.sort.chunk.size.in.mb | 128 | Size of memory to allocate for sorting.Can increase this based on the memory available |
| Data Loading | carbon.number.of.cores.while.loading | 12 | Higher cores can improve data loading speed |
| Data Loading | carbon.sort.size | 100000 | Number of records to sort at a time.More number of records configured will lead to increased memory foot print |
-| Data Loading | table_blocksize | 512 | To efficiently schedule multiple tasks during query.This size depends on data scenario.If data is such that the filters would select less number of blocklets to scan, keeping higher number works well.If the number blocklets to scan is more, better to reduce the size as more tasks can be scheduled in parallel. |
+| Data Loading | table_blocksize | 512 | To efficiently schedule multiple tasks during query. This size depends on data scenario.If data is such that the filters would select less number of blocklets to scan, keeping higher number works well.If the number blocklets to scan is more, better to reduce the size as more tasks can be scheduled in parallel. |
| Data Loading | carbon.sort.intermediate.files.limit | 100 | Increased to 100 as number of cores are more.Can perform merging in backgorund.If less number of files to merge, sort threads would be idle |
-| Data Loading | carbon.use.local.dir | TRUE | yarn application directory will be usually on a single disk.YARN would be configured with multiple disks to be used as temp or to assign randomly to applications.Using the yarn temp directory will allow carbon to use multiple disks and improve IO performance |
+| Data Loading | carbon.use.local.dir | TRUE | yarn application directory will be usually on a single disk.YARN would be configured with multiple disks to be used as temp or to assign randomly to applications. Using the yarn temp directory will allow carbon to use multiple disks and improve IO performance |
| Data Loading | carbon.use.multiple.temp.dir | TRUE | multiple disks to write sort files will lead to better IO and reduce the IO bottleneck |
-| Data Loading | sort.inmemory.size.in.mb | 92160 | Memory allocated to do inmemory sorting.When more memory is available in the node, configuring this will retain more sort blocks in memory so that the merge sort is faster due to no/very less IO |
+| Data Loading | sort.inmemory.size.in.mb | 92160 | Memory allocated to do inmemory sorting. When more memory is available in the node, configuring this will retain more sort blocks in memory so that the merge sort is faster due to no/very less IO |
| Compaction | carbon.major.compaction.size | 921600 | Sum of several loads to combine into single segment |
| Compaction | carbon.number.of.cores.while.compacting | 12 | Higher number of cores can improve the compaction speed.Data size is huge.Compaction need to use more threads to speed up the process |
-| Compaction | carbon.enable.auto.load.merge | FALSE | Doing auto minor compaction is costly process as data size is huge.Perform manual compaction when the cluster is less loaded |
+| Compaction | carbon.enable.auto.load.merge | FALSE | Doing auto minor compaction is costly process as data size is huge.Perform manual compaction when the cluster is less loaded |
| Query | carbon.enable.vector.reader | true | To fetch results faster, supporting spark vector processing will speed up the query |
-| Query | enable.unsafe.in.query.procressing | true | Data that needs to be scanned in huge which in turn generates more short lived Java objects.This cause pressure of GC.using unsafe and offheap will reduce the GC overhead |
-| Query | use.offheap.in.query.processing | true | Data that needs to be scanned in huge which in turn generates more short lived Java objects.This cause pressure of GC.using unsafe and offheap will reduce the GC overhead.offheap can be accessed through java unsafe.hence enable.unsafe.in.query.procressing needs to be true |
+| Query | enable.unsafe.in.query.procressing | true | Data that needs to be scanned in huge which in turn generates more short lived Java objects. This cause pressure of GC.using unsafe and offheap will reduce the GC overhead |
+| Query | use.offheap.in.query.processing | true | Data that needs to be scanned in huge which in turn generates more short lived Java objects. This cause pressure of GC.using unsafe and offheap will reduce the GC overhead.offheap can be accessed through java unsafe.hence enable.unsafe.in.query.procressing needs to be true |
| Query | enable.unsafe.columnpage | TRUE | Keep the column pages in offheap memory so that the memory overhead due to java object is less and also reduces GC pressure. |
-| Query | carbon.unsafe.working.memory.in.mb | 10240 | Amount of memory to use for offheap operations.Can increase this memory based on the data size |
+| Query | carbon.unsafe.working.memory.in.mb | 10240 | Amount of memory to use for offheap operations, you can increase this memory based on the data size |
@@ -177,7 +177,7 @@ Concurrent queries can be more due to the BI dashboard
- Create pre-aggregate tables for non timestamp based group by queries
- For queries containing group by date, create timeseries based Datamap(pre-aggregate) tables so that the data is rolled up during creation and fetch is faster
- Reduce the Spark shuffle partitions.(In our configuration on 14 node cluster, it was reduced to 35 from default of 200)
-- Enable global dictionary for columns which have less cardinalities.Aggregation can be done on encoded data, there by improving the performance
+- Enable global dictionary for columns which have less cardinalities. Aggregation can be done on encoded data, there by improving the performance
- For columns whose cardinality is high,enable the local dictionary so that store size is less and can take dictionary benefit for scan
## Handling near realtime data ingestion scenario
@@ -188,14 +188,14 @@ Need to support storing of continously arriving data and make it available immed
### Challenges
-When the data ingestion is near real time and the data needs to be available for query immediately, usual scenario is to do data loading in micro batches.But this causes the problem of generating many small files.This poses two problems:
+When the data ingestion is near real time and the data needs to be available for query immediately, usual scenario is to do data loading in micro batches.But this causes the problem of generating many small files. This poses two problems:
1. Small file handling in HDFS is inefficient
2. CarbonData will suffer in query performance as all the small files will have to be queried when filter is on non time column
CarbonData will suffer in query performance as all the small files will have to be queried when filter is on non time column.
-Since data is continouly arriving, allocating resources for compaction might not be feasible.
+Since data is continously arriving, allocating resources for compaction might not be feasible.
### Goal
[17/20] carbondata-site git commit: Updated changes for 1.5.0 release
Posted by ch...@apache.org.
http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6f8949f1/content/useful-tips-on-carbondata.html
----------------------------------------------------------------------
diff --git a/content/useful-tips-on-carbondata.html b/content/useful-tips-on-carbondata.html
new file mode 100644
index 0000000..912cb48
--- /dev/null
+++ b/content/useful-tips-on-carbondata.html
@@ -0,0 +1,480 @@
+<!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.4.1/"
+ target="_blank">Apache CarbonData 1.4.1</a></li>
+ <li>
+ <a href="https://dist.apache.org/repos/dist/release/carbondata/1.4.0/"
+ target="_blank">Apache CarbonData 1.4.0</a></li>
+ <li>
+ <a href="https://dist.apache.org/repos/dist/release/carbondata/1.3.1/"
+ target="_blank">Apache CarbonData 1.3.1</a></li>
+ <li>
+ <a href="https://dist.apache.org/repos/dist/release/carbondata/1.3.0/"
+ target="_blank">Apache CarbonData 1.3.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="useful-tips" class="anchor" href="#useful-tips" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Useful Tips</h1>
+<p>This tutorial guides you to create CarbonData Tables and optimize performance.
+The following sections will elaborate on the below topics :</p>
+<ul>
+<li><a href="#suggestions-to-create-carbondata-table">Suggestions to create CarbonData Table</a></li>
+<li><a href="#configuration-for-optimizing-data-loading-performance-for-massive-data">Configuration for Optimizing Data Loading performance for Massive Data</a></li>
+<li><a href="#configurations-for-optimizing-carbondata-performance">Optimizing Mass Data Loading</a></li>
+</ul>
+<h2>
+<a id="suggestions-to-create-carbondata-table" class="anchor" href="#suggestions-to-create-carbondata-table" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Suggestions to Create CarbonData Table</h2>
+<p>For example, the results of the analysis for table creation with dimensions ranging from 10 thousand to 10 billion rows and 100 to 300 columns have been summarized below.
+The following table describes some of the columns from the table used.</p>
+<ul>
+<li><strong>Table Column Description</strong></li>
+</ul>
+<table>
+<thead>
+<tr>
+<th>Column Name</th>
+<th>Data Type</th>
+<th>Cardinality</th>
+<th>Attribution</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>msisdn</td>
+<td>String</td>
+<td>30 million</td>
+<td>Dimension</td>
+</tr>
+<tr>
+<td>BEGIN_TIME</td>
+<td>BigInt</td>
+<td>10 Thousand</td>
+<td>Dimension</td>
+</tr>
+<tr>
+<td>HOST</td>
+<td>String</td>
+<td>1 million</td>
+<td>Dimension</td>
+</tr>
+<tr>
+<td>Dime_1</td>
+<td>String</td>
+<td>1 Thousand</td>
+<td>Dimension</td>
+</tr>
+<tr>
+<td>counter_1</td>
+<td>Decimal</td>
+<td>NA</td>
+<td>Measure</td>
+</tr>
+<tr>
+<td>counter_2</td>
+<td>Numeric(20,0)</td>
+<td>NA</td>
+<td>Measure</td>
+</tr>
+<tr>
+<td>...</td>
+<td>...</td>
+<td>NA</td>
+<td>Measure</td>
+</tr>
+<tr>
+<td>counter_100</td>
+<td>Decimal</td>
+<td>NA</td>
+<td>Measure</td>
+</tr>
+</tbody>
+</table>
+<ul>
+<li><strong>Put the frequently-used column filter in the beginning</strong></li>
+</ul>
+<p>For example, MSISDN filter is used in most of the query then we must put the MSISDN in the first column.
+The create table command can be modified as suggested below :</p>
+<pre><code>create table carbondata_table(
+ msisdn String,
+ BEGIN_TIME bigint,
+ HOST String,
+ Dime_1 String,
+ counter_1, Decimal
+ ...
+
+ )STORED BY 'carbondata'
+ TBLPROPERTIES ('SORT_COLUMNS'='msisdn, Dime_1')
+</code></pre>
+<p>Now the query with MSISDN in the filter will be more efficient.</p>
+<ul>
+<li><strong>Put the frequently-used columns in the order of low to high cardinality</strong></li>
+</ul>
+<p>If the table in the specified query has multiple columns which are frequently used to filter the results, it is suggested to put
+the columns in the order of cardinality low to high. This ordering of frequently used columns improves the compression ratio and
+enhances the performance of queries with filter on these columns.</p>
+<p>For example, if MSISDN, HOST and Dime_1 are frequently-used columns, then the column order of table is suggested as
+Dime_1>HOST>MSISDN, because Dime_1 has the lowest cardinality.
+The create table command can be modified as suggested below :</p>
+<pre><code>create table carbondata_table(
+ msisdn String,
+ BEGIN_TIME bigint,
+ HOST String,
+ Dime_1 String,
+ counter_1, Decimal
+ ...
+
+ )STORED BY 'carbondata'
+ TBLPROPERTIES ('SORT_COLUMNS'='Dime_1, HOST, MSISDN')
+</code></pre>
+<ul>
+<li><strong>For measure type columns with non high accuracy, replace Numeric(20,0) data type with Double data type</strong></li>
+</ul>
+<p>For columns of measure type, not requiring high accuracy, it is suggested to replace Numeric data type with Double to enhance query performance.
+The create table command can be modified as below :</p>
+<pre><code> create table carbondata_table(
+ Dime_1 String,
+ BEGIN_TIME bigint,
+ END_TIME bigint,
+ HOST String,
+ MSISDN String,
+ counter_1 decimal,
+ counter_2 double,
+ ...
+ )STORED BY 'carbondata'
+ TBLPROPERTIES ('SORT_COLUMNS'='Dime_1, HOST, MSISDN')
+</code></pre>
+<p>The result of performance analysis of test-case shows reduction in query execution time from 15 to 3 seconds, thereby improving performance by nearly 5 times.</p>
+<ul>
+<li><strong>Columns of incremental character should be re-arranged at the end of dimensions</strong></li>
+</ul>
+<p>Consider the following scenario where data is loaded each day and the begin_time is incremental for each load, it is suggested to put begin_time at the end of dimensions.
+Incremental values are efficient in using min/max index. The create table command can be modified as below :</p>
+<pre><code>create table carbondata_table(
+ Dime_1 String,
+ HOST String,
+ MSISDN String,
+ counter_1 double,
+ counter_2 double,
+ BEGIN_TIME bigint,
+ END_TIME bigint,
+ ...
+ counter_100 double
+ )STORED BY 'carbondata'
+ TBLPROPERTIES ('SORT_COLUMNS'='Dime_1, HOST, MSISDN')
+</code></pre>
+<p><strong>NOTE:</strong></p>
+<ul>
+<li>BloomFilter can be created to enhance performance for queries with precise equal/in conditions. You can find more information about it in BloomFilter datamap <a href="https://github.com/apache/carbondata/blob/master/docs/datamap/bloomfilter-datamap-guide.html" target=_blank>document</a>.</li>
+</ul>
+<h2>
+<a id="configuration-for-optimizing-data-loading-performance-for-massive-data" class="anchor" href="#configuration-for-optimizing-data-loading-performance-for-massive-data" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Configuration for Optimizing Data Loading performance for Massive Data</h2>
+<p>CarbonData supports large data load, in this process sorting data while loading consumes a lot of memory and disk IO and
+this can result sometimes in "Out Of Memory" exception.
+If you do not have much memory to use, then you may prefer to slow the speed of data loading instead of data load failure.
+You can configure CarbonData by tuning following properties in carbon.properties file to get a better performance.</p>
+<table>
+<thead>
+<tr>
+<th>Parameter</th>
+<th>Default Value</th>
+<th>Description/Tuning</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>carbon.number.of.cores.while.loading</td>
+<td>Default: 2.This value should be >= 2</td>
+<td>Specifies the number of cores used for data processing during data loading in CarbonData.</td>
+</tr>
+<tr>
+<td>carbon.sort.size</td>
+<td>Default: 100000. The value should be >= 100.</td>
+<td>Threshold to write local file in sort step when loading data</td>
+</tr>
+<tr>
+<td>carbon.sort.file.write.buffer.size</td>
+<td>Default: 50000.</td>
+<td>DataOutputStream buffer.</td>
+</tr>
+<tr>
+<td>carbon.number.of.cores.block.sort</td>
+<td>Default: 7</td>
+<td>If you have huge memory and CPUs, increase it as you will</td>
+</tr>
+<tr>
+<td>carbon.merge.sort.reader.thread</td>
+<td>Default: 3</td>
+<td>Specifies the number of cores used for temp file merging during data loading in CarbonData.</td>
+</tr>
+<tr>
+<td>carbon.merge.sort.prefetch</td>
+<td>Default: true</td>
+<td>You may want set this value to false if you have not enough memory</td>
+</tr>
+</tbody>
+</table>
+<p>For example, if there are 10 million records, and i have only 16 cores, 64GB memory, will be loaded to CarbonData table.
+Using the default configuration always fail in sort step. Modify carbon.properties as suggested below:</p>
+<pre><code>carbon.number.of.cores.block.sort=1
+carbon.merge.sort.reader.thread=1
+carbon.sort.size=5000
+carbon.sort.file.write.buffer.size=5000
+carbon.merge.sort.prefetch=false
+</code></pre>
+<h2>
+<a id="configurations-for-optimizing-carbondata-performance" class="anchor" href="#configurations-for-optimizing-carbondata-performance" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Configurations for Optimizing CarbonData Performance</h2>
+<p>Recently we did some performance POC on CarbonData for Finance and telecommunication Field. It involved detailed queries and aggregation
+scenarios. After the completion of POC, some of the configurations impacting the performance have been identified and tabulated below :</p>
+<table>
+<thead>
+<tr>
+<th>Parameter</th>
+<th>Location</th>
+<th>Used For</th>
+<th>Description</th>
+<th>Tuning</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>carbon.sort.intermediate.files.limit</td>
+<td>spark/carbonlib/carbon.properties</td>
+<td>Data loading</td>
+<td>During the loading of data, local temp is used to sort the data. This number specifies the minimum number of intermediate files after which the merge sort has to be initiated.</td>
+<td>Increasing the parameter to a higher value will improve the load performance. For example, when we increase the value from 20 to 100, it increases the data load performance from 35MB/S to more than 50MB/S. Higher values of this parameter consumes more memory during the load.</td>
+</tr>
+<tr>
+<td>carbon.number.of.cores.while.loading</td>
+<td>spark/carbonlib/carbon.properties</td>
+<td>Data loading</td>
+<td>Specifies the number of cores used for data processing during data loading in CarbonData.</td>
+<td>If you have more number of CPUs, then you can increase the number of CPUs, which will increase the performance. For example if we increase the value from 2 to 4 then the CSV reading performance can increase about 1 times</td>
+</tr>
+<tr>
+<td>carbon.compaction.level.threshold</td>
+<td>spark/carbonlib/carbon.properties</td>
+<td>Data loading and Querying</td>
+<td>For minor compaction, specifies the number of segments to be merged in stage 1 and number of compacted segments to be merged in stage 2.</td>
+<td>Each CarbonData load will create one segment, if every load is small in size it will generate many small file over a period of time impacting the query performance. Configuring this parameter will merge the small segment to one big segment which will sort the data and improve the performance. For Example in one telecommunication scenario, the performance improves about 2 times after minor compaction.</td>
+</tr>
+<tr>
+<td>spark.sql.shuffle.partitions</td>
+<td>spark/conf/spark-defaults.conf</td>
+<td>Querying</td>
+<td>The number of task started when spark shuffle.</td>
+<td>The value can be 1 to 2 times as much as the executor cores. In an aggregation scenario, reducing the number from 200 to 32 reduced the query time from 17 to 9 seconds.</td>
+</tr>
+<tr>
+<td>spark.executor.instances/spark.executor.cores/spark.executor.memory</td>
+<td>spark/conf/spark-defaults.conf</td>
+<td>Querying</td>
+<td>The number of executors, CPU cores, and memory used for CarbonData query.</td>
+<td>In the bank scenario, we provide the 4 CPUs cores and 15 GB for each executor which can get good performance. This 2 value does not mean more the better. It needs to be configured properly in case of limited resources. For example, In the bank scenario, it has enough CPU 32 cores each node but less memory 64 GB each node. So we cannot give more CPU but less memory. For example, when 4 cores and 12GB for each executor. It sometimes happens GC during the query which impact the query performance very much from the 3 second to more than 15 seconds. In this scenario need to increase the memory or decrease the CPU cores.</td>
+</tr>
+<tr>
+<td>carbon.detail.batch.size</td>
+<td>spark/carbonlib/carbon.properties</td>
+<td>Data loading</td>
+<td>The buffer size to store records, returned from the block scan.</td>
+<td>In limit scenario this parameter is very important. For example your query limit is 1000. But if we set this value to 3000 that means we get 3000 records from scan but spark will only take 1000 rows. So the 2000 remaining are useless. In one Finance test case after we set it to 100, in the limit 1000 scenario the performance increase about 2 times in comparison to if we set this value to 12000.</td>
+</tr>
+<tr>
+<td>carbon.use.local.dir</td>
+<td>spark/carbonlib/carbon.properties</td>
+<td>Data loading</td>
+<td>Whether use YARN local directories for multi-table load disk load balance</td>
+<td>If this is set it to true CarbonData will use YARN local directories for multi-table load disk load balance, that will improve the data load performance.</td>
+</tr>
+<tr>
+<td>carbon.use.multiple.temp.dir</td>
+<td>spark/carbonlib/carbon.properties</td>
+<td>Data loading</td>
+<td>Whether to use multiple YARN local directories during table data loading for disk load balance</td>
+<td>After enabling 'carbon.use.local.dir', if this is set to true, CarbonData will use all YARN local directories during data load for disk load balance, that will improve the data load performance. Please enable this property when you encounter disk hotspot problem during data loading.</td>
+</tr>
+<tr>
+<td>carbon.sort.temp.compressor</td>
+<td>spark/carbonlib/carbon.properties</td>
+<td>Data loading</td>
+<td>Specify the name of compressor to compress the intermediate sort temporary files during sort procedure in data loading.</td>
+<td>The optional values are 'SNAPPY','GZIP','BZIP2','LZ4','ZSTD' and empty. By default, empty means that Carbondata will not compress the sort temp files. This parameter will be useful if you encounter disk bottleneck.</td>
+</tr>
+<tr>
+<td>carbon.load.skewedDataOptimization.enabled</td>
+<td>spark/carbonlib/carbon.properties</td>
+<td>Data loading</td>
+<td>Whether to enable size based block allocation strategy for data loading.</td>
+<td>When loading, carbondata will use file size based block allocation strategy for task distribution. It will make sure that all the executors process the same size of data -- It's useful if the size of your input data files varies widely, say 1MB~1GB.</td>
+</tr>
+<tr>
+<td>carbon.load.min.size.enabled</td>
+<td>spark/carbonlib/carbon.properties</td>
+<td>Data loading</td>
+<td>Whether to enable node minumun input data size allocation strategy for data loading.</td>
+<td>When loading, carbondata will use node minumun input data size allocation strategy for task distribution. It will make sure the node load the minimum amount of data -- It's useful if the size of your input data files very small, say 1MB~256MB,Avoid generating a large number of small files.</td>
+</tr>
+</tbody>
+</table>
+<p>Note: If your CarbonData instance is provided only for query, you may specify the property 'spark.speculation=true' which is in conf directory of spark.</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
[08/20] carbondata-site git commit: modified for 1.5.0 version
Posted by ch...@apache.org.
http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6ad7599a/content/troubleshooting.html
----------------------------------------------------------------------
diff --git a/content/troubleshooting.html b/content/troubleshooting.html
deleted file mode 100644
index c668dc9..0000000
--- a/content/troubleshooting.html
+++ /dev/null
@@ -1,366 +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.4.1/"
- target="_blank">Apache CarbonData 1.4.1</a></li>
- <li>
- <a href="https://dist.apache.org/repos/dist/release/carbondata/1.4.0/"
- target="_blank">Apache CarbonData 1.4.0</a></li>
- <li>
- <a href="https://dist.apache.org/repos/dist/release/carbondata/1.3.1/"
- target="_blank">Apache CarbonData 1.3.1</a></li>
- <li>
- <a href="https://dist.apache.org/repos/dist/release/carbondata/1.3.0/"
- target="_blank">Apache CarbonData 1.3.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="troubleshooting" class="anchor" href="#troubleshooting" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Troubleshooting</h1>
-<p>This tutorial is designed to provide troubleshooting for end users and developers
-who are building, deploying, and using CarbonData.</p>
-<h2>
-<a id="when-loading-data-gets-tablestatuslock-issues" class="anchor" href="#when-loading-data-gets-tablestatuslock-issues" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>When loading data, gets tablestatus.lock issues:</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)
-java.io.FileNotFoundException: hdfs:/localhost:9000/carbon/store/default/hdfstable/tablestatus.lock (No such file or directory)
- at java.io.FileOutputStream.open0(Native Method)
- at java.io.FileOutputStream.open(FileOutputStream.java:270)
- at java.io.FileOutputStream.<init>(FileOutputStream.java:213)
- at java.io.FileOutputStream.<init>(FileOutputStream.java:101)
-</code></pre>
-<p><strong>Possible Cause</strong>
-If you use <code><hdfs path></code> as store path when creating carbonsession, may get the errors,because the default is LOCALLOCK.</p>
-<p><strong>Procedure</strong>
-Before creating carbonsession, sets as below:</p>
-<pre><code>import org.apache.carbondata.core.util.CarbonProperties
-import org.apache.carbondata.core.constants.CarbonCommonConstants
-CarbonProperties.getInstance().addProperty(CarbonCommonConstants.LOCK_TYPE, "HDFSLOCK")
-</code></pre>
-<h2>
-<a id="failed-to-load-thrift-libraries" class="anchor" href="#failed-to-load-thrift-libraries" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Failed to load thrift libraries</h2>
-<p><strong>Symptom</strong></p>
-<p>Thrift throws following exception :</p>
-<pre><code>thrift: error while loading shared libraries:
-libthriftc.so.0: cannot open shared object file: No such file or directory
-</code></pre>
-<p><strong>Possible Cause</strong></p>
-<p>The complete path to the directory containing the libraries is not configured correctly.</p>
-<p><strong>Procedure</strong></p>
-<p>Follow the Apache thrift docs at <a href="https://thrift.apache.org/docs/install" target=_blank rel="nofollow">https://thrift.apache.org/docs/install</a> to install thrift correctly.</p>
-<h2>
-<a id="failed-to-launch-the-spark-shell" class="anchor" href="#failed-to-launch-the-spark-shell" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Failed to launch the Spark Shell</h2>
-<p><strong>Symptom</strong></p>
-<p>The shell prompts the following error :</p>
-<pre><code>org.apache.spark.sql.CarbonContext$$anon$$apache$spark$sql$catalyst$analysis
-$OverrideCatalog$_setter_$org$apache$spark$sql$catalyst$analysis
-$OverrideCatalog$$overrides_$e
-</code></pre>
-<p><strong>Possible Cause</strong></p>
-<p>The Spark Version and the selected Spark Profile do not match.</p>
-<p><strong>Procedure</strong></p>
-<ol>
-<li>
-<p>Ensure your spark version and selected profile for spark are correct.</p>
-</li>
-<li>
-<p>Use the following command :</p>
-</li>
-</ol>
-<pre><code>"mvn -Pspark-2.1 -Dspark.version {yourSparkVersion} clean package"
-</code></pre>
-<p>Note : Refrain from using "mvn clean package" without specifying the profile.</p>
-<h2>
-<a id="failed-to-execute-load-query-on-cluster" class="anchor" href="#failed-to-execute-load-query-on-cluster" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Failed to execute load query on cluster.</h2>
-<p><strong>Symptom</strong></p>
-<p>Load query failed with the following exception:</p>
-<pre><code>Dictionary file is locked for updation.
-</code></pre>
-<p><strong>Possible Cause</strong></p>
-<p>The carbon.properties file is not identical in all the nodes of the cluster.</p>
-<p><strong>Procedure</strong></p>
-<p>Follow the steps to ensure the carbon.properties file is consistent across all the nodes:</p>
-<ol>
-<li>
-<p>Copy the carbon.properties file from the master node to all the other nodes in the cluster.
-For example, you can use ssh to copy this file to all the nodes.</p>
-</li>
-<li>
-<p>For the changes to take effect, restart the Spark cluster.</p>
-</li>
-</ol>
-<h2>
-<a id="failed-to-execute-insert-query-on-cluster" class="anchor" href="#failed-to-execute-insert-query-on-cluster" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Failed to execute insert query on cluster.</h2>
-<p><strong>Symptom</strong></p>
-<p>Load query failed with the following exception:</p>
-<pre><code>Dictionary file is locked for updation.
-</code></pre>
-<p><strong>Possible Cause</strong></p>
-<p>The carbon.properties file is not identical in all the nodes of the cluster.</p>
-<p><strong>Procedure</strong></p>
-<p>Follow the steps to ensure the carbon.properties file is consistent across all the nodes:</p>
-<ol>
-<li>
-<p>Copy the carbon.properties file from the master node to all the other nodes in the cluster.
-For example, you can use scp to copy this file to all the nodes.</p>
-</li>
-<li>
-<p>For the changes to take effect, restart the Spark cluster.</p>
-</li>
-</ol>
-<h2>
-<a id="failed-to-connect-to-hiveuser-with-thrift" class="anchor" href="#failed-to-connect-to-hiveuser-with-thrift" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Failed to connect to hiveuser with thrift</h2>
-<p><strong>Symptom</strong></p>
-<p>We get the following exception :</p>
-<pre><code>Cannot connect to hiveuser.
-</code></pre>
-<p><strong>Possible Cause</strong></p>
-<p>The external process does not have permission to access.</p>
-<p><strong>Procedure</strong></p>
-<p>Ensure that the Hiveuser in mysql must allow its access to the external processes.</p>
-<h2>
-<a id="failed-to-read-the-metastore-db-during-table-creation" class="anchor" href="#failed-to-read-the-metastore-db-during-table-creation" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Failed to read the metastore db during table creation.</h2>
-<p><strong>Symptom</strong></p>
-<p>We get the following exception on trying to connect :</p>
-<pre><code>Cannot read the metastore db
-</code></pre>
-<p><strong>Possible Cause</strong></p>
-<p>The metastore db is dysfunctional.</p>
-<p><strong>Procedure</strong></p>
-<p>Remove the metastore db from the carbon.metastore in the Spark Directory.</p>
-<h2>
-<a id="failed-to-load-data-on-the-cluster" class="anchor" href="#failed-to-load-data-on-the-cluster" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Failed to load data on the cluster</h2>
-<p><strong>Symptom</strong></p>
-<p>Data loading fails with the following exception :</p>
-<pre><code>Data Load failure exception
-</code></pre>
-<p><strong>Possible Cause</strong></p>
-<p>The following issue can cause the failure :</p>
-<ol>
-<li>
-<p>The core-site.xml, hive-site.xml, yarn-site and carbon.properties are not consistent across all nodes of the cluster.</p>
-</li>
-<li>
-<p>Path to hdfs ddl is not configured correctly in the carbon.properties.</p>
-</li>
-</ol>
-<p><strong>Procedure</strong></p>
-<p>Follow the steps to ensure the following configuration files are consistent across all the nodes:</p>
-<ol>
-<li>
-<p>Copy the core-site.xml, hive-site.xml, yarn-site,carbon.properties files from the master node to all the other nodes in the cluster.
-For example, you can use scp to copy this file to all the nodes.</p>
-<p>Note : Set the path to hdfs ddl in carbon.properties in the master node.</p>
-</li>
-<li>
-<p>For the changes to take effect, restart the Spark cluster.</p>
-</li>
-</ol>
-<h2>
-<a id="failed-to-insert-data-on-the-cluster" class="anchor" href="#failed-to-insert-data-on-the-cluster" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Failed to insert data on the cluster</h2>
-<p><strong>Symptom</strong></p>
-<p>Insertion fails with the following exception :</p>
-<pre><code>Data Load failure exception
-</code></pre>
-<p><strong>Possible Cause</strong></p>
-<p>The following issue can cause the failure :</p>
-<ol>
-<li>
-<p>The core-site.xml, hive-site.xml, yarn-site and carbon.properties are not consistent across all nodes of the cluster.</p>
-</li>
-<li>
-<p>Path to hdfs ddl is not configured correctly in the carbon.properties.</p>
-</li>
-</ol>
-<p><strong>Procedure</strong></p>
-<p>Follow the steps to ensure the following configuration files are consistent across all the nodes:</p>
-<ol>
-<li>
-<p>Copy the core-site.xml, hive-site.xml, yarn-site,carbon.properties files from the master node to all the other nodes in the cluster.
-For example, you can use scp to copy this file to all the nodes.</p>
-<p>Note : Set the path to hdfs ddl in carbon.properties in the master node.</p>
-</li>
-<li>
-<p>For the changes to take effect, restart the Spark cluster.</p>
-</li>
-</ol>
-<h2>
-<a id="failed-to-execute-concurrent-operationsloadinsertupdate-on-table-by-multiple-workers" class="anchor" href="#failed-to-execute-concurrent-operationsloadinsertupdate-on-table-by-multiple-workers" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Failed to execute Concurrent Operations(Load,Insert,Update) on table by multiple workers.</h2>
-<p><strong>Symptom</strong></p>
-<p>Execution fails with the following exception :</p>
-<pre><code>Table is locked for updation.
-</code></pre>
-<p><strong>Possible Cause</strong></p>
-<p>Concurrency not supported.</p>
-<p><strong>Procedure</strong></p>
-<p>Worker must wait for the query execution to complete and the table to release the lock for another query execution to succeed.</p>
-<h2>
-<a id="failed-to-create-a-table-with-a-single-numeric-column" class="anchor" href="#failed-to-create-a-table-with-a-single-numeric-column" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Failed to create a table with a single numeric column.</h2>
-<p><strong>Symptom</strong></p>
-<p>Execution fails with the following exception :</p>
-<pre><code>Table creation fails.
-</code></pre>
-<p><strong>Possible Cause</strong></p>
-<p>Behaviour not supported.</p>
-<p><strong>Procedure</strong></p>
-<p>A single column that can be considered as dimension is mandatory for table creation.</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/usecases.html
----------------------------------------------------------------------
diff --git a/content/usecases.html b/content/usecases.html
index cb309dd..3ff114a 100644
--- a/content/usecases.html
+++ b/content/usecases.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>
@@ -258,7 +266,7 @@
<a id="detailed-queries-in-the-telecom-scenario" class="anchor" href="#detailed-queries-in-the-telecom-scenario" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Detailed Queries in the Telecom scenario</h2>
<h3>
<a id="scenario" class="anchor" href="#scenario" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Scenario</h3>
-<p>User wants to analyse all the CHR(Call History Record) and MR(Measurement Records) of the mobile subscribers in order to identify the service failures within 10 secs.Also user wants to run machine learning models on the data to fairly estimate the reasons and time of probable failures and take action ahead to meet the SLA(Service Level Agreements) of VIP customers.</p>
+<p>User wants to analyse all the CHR(Call History Record) and MR(Measurement Records) of the mobile subscribers in order to identify the service failures within 10 secs. Also user wants to run machine learning models on the data to fairly estimate the reasons and time of probable failures and take action ahead to meet the SLA(Service Level Agreements) of VIP customers.</p>
<h3>
<a id="challenges" class="anchor" href="#challenges" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Challenges</h3>
<ul>
@@ -271,7 +279,7 @@
<a id="solution" class="anchor" href="#solution" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Solution</h3>
<p>Setup a Hadoop + Spark + CarbonData cluster managed by YARN.</p>
<p>Proposed the following configurations for CarbonData.(These tunings were proposed before CarbonData introduced SORT_COLUMNS parameter using which the sort order and schema order could be different.)</p>
-<p>Add the frequently used columns to the left of the table definition.Add it in the increasing order of cardinality.It was suggested to keep msisdn,imsi columns in the beginning of the schema.With latest CarbonData, SORT_COLUMNS needs to be configured msisdn,imsi in the beginning.</p>
+<p>Add the frequently used columns to the left of the table definition. Add it in the increasing order of cardinality. It was suggested to keep msisdn,imsi columns in the beginning of the schema. With latest CarbonData, SORT_COLUMNS needs to be configured msisdn,imsi in the beginning.</p>
<p>Add timestamp column to the right of the schema as it is naturally increasing.</p>
<p>Create two separate YARN queues for Query and Data Loading.</p>
<p>Apart from these, the following CarbonData configuration was suggested to be configured in the cluster.</p>
@@ -319,7 +327,7 @@
<td>Data Loading</td>
<td>carbon.use.local.dir</td>
<td>TRUE</td>
-<td>yarn application directory will be usually on a single disk.YARN would be configured with multiple disks to be used as temp or to assign randomly to applications.Using the yarn temp directory will allow carbon to use multiple disks and improve IO performance</td>
+<td>yarn application directory will be usually on a single disk.YARN would be configured with multiple disks to be used as temp or to assign randomly to applications. Using the yarn temp directory will allow carbon to use multiple disks and improve IO performance</td>
</tr>
<tr>
<td>Data Loading</td>
@@ -381,7 +389,7 @@
<a id="detailed-queries-in-the-smart-city-scenario" class="anchor" href="#detailed-queries-in-the-smart-city-scenario" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Detailed Queries in the Smart City scenario</h2>
<h3>
<a id="scenario-1" class="anchor" href="#scenario-1" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Scenario</h3>
-<p>User wants to analyse the person/vehicle movement and behavior during a certain time period.This output data needs to be joined with a external table for Human details extraction.The query will be run with different time period as filter to identify potential behavior mismatch.</p>
+<p>User wants to analyse the person/vehicle movement and behavior during a certain time period. This output data needs to be joined with a external table for Human details extraction. The query will be run with different time period as filter to identify potential behavior mismatch.</p>
<h3>
<a id="challenges-1" class="anchor" href="#challenges-1" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Challenges</h3>
<p>Data generated per day is very huge.Data needs to be loaded multiple times per day to accomodate the incoming data size.</p>
@@ -414,13 +422,13 @@
<td>Data Loading</td>
<td>enable.unsafe.sort</td>
<td>TRUE</td>
-<td>Temporary data generated during sort is huge which causes GC bottlenecks.Using unsafe reduces the pressure on GC</td>
+<td>Temporary data generated during sort is huge which causes GC bottlenecks. Using unsafe reduces the pressure on GC</td>
</tr>
<tr>
<td>Data Loading</td>
<td>enable.offheap.sort</td>
<td>TRUE</td>
-<td>Temporary data generated during sort is huge which causes GC bottlenecks.Using offheap reduces the pressure on GC.offheap can be accessed through java unsafe.hence enable.unsafe.sort needs to be true</td>
+<td>Temporary data generated during sort is huge which causes GC bottlenecks. Using offheap reduces the pressure on GC.offheap can be accessed through java unsafe.hence enable.unsafe.sort needs to be true</td>
</tr>
<tr>
<td>Data Loading</td>
@@ -444,7 +452,7 @@
<td>Data Loading</td>
<td>table_blocksize</td>
<td>512</td>
-<td>To efficiently schedule multiple tasks during query.This size depends on data scenario.If data is such that the filters would select less number of blocklets to scan, keeping higher number works well.If the number blocklets to scan is more, better to reduce the size as more tasks can be scheduled in parallel.</td>
+<td>To efficiently schedule multiple tasks during query. This size depends on data scenario.If data is such that the filters would select less number of blocklets to scan, keeping higher number works well.If the number blocklets to scan is more, better to reduce the size as more tasks can be scheduled in parallel.</td>
</tr>
<tr>
<td>Data Loading</td>
@@ -456,7 +464,7 @@
<td>Data Loading</td>
<td>carbon.use.local.dir</td>
<td>TRUE</td>
-<td>yarn application directory will be usually on a single disk.YARN would be configured with multiple disks to be used as temp or to assign randomly to applications.Using the yarn temp directory will allow carbon to use multiple disks and improve IO performance</td>
+<td>yarn application directory will be usually on a single disk.YARN would be configured with multiple disks to be used as temp or to assign randomly to applications. Using the yarn temp directory will allow carbon to use multiple disks and improve IO performance</td>
</tr>
<tr>
<td>Data Loading</td>
@@ -468,7 +476,7 @@
<td>Data Loading</td>
<td>sort.inmemory.size.in.mb</td>
<td>92160</td>
-<td>Memory allocated to do inmemory sorting.When more memory is available in the node, configuring this will retain more sort blocks in memory so that the merge sort is faster due to no/very less IO</td>
+<td>Memory allocated to do inmemory sorting. When more memory is available in the node, configuring this will retain more sort blocks in memory so that the merge sort is faster due to no/very less IO</td>
</tr>
<tr>
<td>Compaction</td>
@@ -486,7 +494,7 @@
<td>Compaction</td>
<td>carbon.enable.auto.load.merge</td>
<td>FALSE</td>
-<td>Doing auto minor compaction is costly process as data size is huge.Perform manual compaction when the cluster is less loaded</td>
+<td>Doing auto minor compaction is costly process as data size is huge.Perform manual compaction when the cluster is less loaded</td>
</tr>
<tr>
<td>Query</td>
@@ -498,13 +506,13 @@
<td>Query</td>
<td>enable.unsafe.in.query.procressing</td>
<td>true</td>
-<td>Data that needs to be scanned in huge which in turn generates more short lived Java objects.This cause pressure of GC.using unsafe and offheap will reduce the GC overhead</td>
+<td>Data that needs to be scanned in huge which in turn generates more short lived Java objects. This cause pressure of GC.using unsafe and offheap will reduce the GC overhead</td>
</tr>
<tr>
<td>Query</td>
<td>use.offheap.in.query.processing</td>
<td>true</td>
-<td>Data that needs to be scanned in huge which in turn generates more short lived Java objects.This cause pressure of GC.using unsafe and offheap will reduce the GC overhead.offheap can be accessed through java unsafe.hence enable.unsafe.in.query.procressing needs to be true</td>
+<td>Data that needs to be scanned in huge which in turn generates more short lived Java objects. This cause pressure of GC.using unsafe and offheap will reduce the GC overhead.offheap can be accessed through java unsafe.hence enable.unsafe.in.query.procressing needs to be true</td>
</tr>
<tr>
<td>Query</td>
@@ -516,7 +524,7 @@
<td>Query</td>
<td>carbon.unsafe.working.memory.in.mb</td>
<td>10240</td>
-<td>Amount of memory to use for offheap operations.Can increase this memory based on the data size</td>
+<td>Amount of memory to use for offheap operations, you can increase this memory based on the data size</td>
</tr>
</tbody>
</table>
@@ -565,7 +573,7 @@
<li>Create pre-aggregate tables for non timestamp based group by queries</li>
<li>For queries containing group by date, create timeseries based Datamap(pre-aggregate) tables so that the data is rolled up during creation and fetch is faster</li>
<li>Reduce the Spark shuffle partitions.(In our configuration on 14 node cluster, it was reduced to 35 from default of 200)</li>
-<li>Enable global dictionary for columns which have less cardinalities.Aggregation can be done on encoded data, there by improving the performance</li>
+<li>Enable global dictionary for columns which have less cardinalities. Aggregation can be done on encoded data, there by improving the performance</li>
<li>For columns whose cardinality is high,enable the local dictionary so that store size is less and can take dictionary benefit for scan</li>
</ul>
<h2>
@@ -575,13 +583,13 @@
<p>Need to support storing of continously arriving data and make it available immediately for query.</p>
<h3>
<a id="challenges-3" class="anchor" href="#challenges-3" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Challenges</h3>
-<p>When the data ingestion is near real time and the data needs to be available for query immediately, usual scenario is to do data loading in micro batches.But this causes the problem of generating many small files.This poses two problems:</p>
+<p>When the data ingestion is near real time and the data needs to be available for query immediately, usual scenario is to do data loading in micro batches.But this causes the problem of generating many small files. This poses two problems:</p>
<ol>
<li>Small file handling in HDFS is inefficient</li>
<li>CarbonData will suffer in query performance as all the small files will have to be queried when filter is on non time column</li>
</ol>
<p>CarbonData will suffer in query performance as all the small files will have to be queried when filter is on non time column.</p>
-<p>Since data is continouly arriving, allocating resources for compaction might not be feasible.</p>
+<p>Since data is continously arriving, allocating resources for compaction might not be feasible.</p>
<h3>
<a id="goal-1" class="anchor" href="#goal-1" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Goal</h3>
<ol>
http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6ad7599a/content/useful-tips-on-carbondata.html
----------------------------------------------------------------------
diff --git a/content/useful-tips-on-carbondata.html b/content/useful-tips-on-carbondata.html
deleted file mode 100644
index 912cb48..0000000
--- a/content/useful-tips-on-carbondata.html
+++ /dev/null
@@ -1,480 +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.4.1/"
- target="_blank">Apache CarbonData 1.4.1</a></li>
- <li>
- <a href="https://dist.apache.org/repos/dist/release/carbondata/1.4.0/"
- target="_blank">Apache CarbonData 1.4.0</a></li>
- <li>
- <a href="https://dist.apache.org/repos/dist/release/carbondata/1.3.1/"
- target="_blank">Apache CarbonData 1.3.1</a></li>
- <li>
- <a href="https://dist.apache.org/repos/dist/release/carbondata/1.3.0/"
- target="_blank">Apache CarbonData 1.3.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="useful-tips" class="anchor" href="#useful-tips" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Useful Tips</h1>
-<p>This tutorial guides you to create CarbonData Tables and optimize performance.
-The following sections will elaborate on the below topics :</p>
-<ul>
-<li><a href="#suggestions-to-create-carbondata-table">Suggestions to create CarbonData Table</a></li>
-<li><a href="#configuration-for-optimizing-data-loading-performance-for-massive-data">Configuration for Optimizing Data Loading performance for Massive Data</a></li>
-<li><a href="#configurations-for-optimizing-carbondata-performance">Optimizing Mass Data Loading</a></li>
-</ul>
-<h2>
-<a id="suggestions-to-create-carbondata-table" class="anchor" href="#suggestions-to-create-carbondata-table" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Suggestions to Create CarbonData Table</h2>
-<p>For example, the results of the analysis for table creation with dimensions ranging from 10 thousand to 10 billion rows and 100 to 300 columns have been summarized below.
-The following table describes some of the columns from the table used.</p>
-<ul>
-<li><strong>Table Column Description</strong></li>
-</ul>
-<table>
-<thead>
-<tr>
-<th>Column Name</th>
-<th>Data Type</th>
-<th>Cardinality</th>
-<th>Attribution</th>
-</tr>
-</thead>
-<tbody>
-<tr>
-<td>msisdn</td>
-<td>String</td>
-<td>30 million</td>
-<td>Dimension</td>
-</tr>
-<tr>
-<td>BEGIN_TIME</td>
-<td>BigInt</td>
-<td>10 Thousand</td>
-<td>Dimension</td>
-</tr>
-<tr>
-<td>HOST</td>
-<td>String</td>
-<td>1 million</td>
-<td>Dimension</td>
-</tr>
-<tr>
-<td>Dime_1</td>
-<td>String</td>
-<td>1 Thousand</td>
-<td>Dimension</td>
-</tr>
-<tr>
-<td>counter_1</td>
-<td>Decimal</td>
-<td>NA</td>
-<td>Measure</td>
-</tr>
-<tr>
-<td>counter_2</td>
-<td>Numeric(20,0)</td>
-<td>NA</td>
-<td>Measure</td>
-</tr>
-<tr>
-<td>...</td>
-<td>...</td>
-<td>NA</td>
-<td>Measure</td>
-</tr>
-<tr>
-<td>counter_100</td>
-<td>Decimal</td>
-<td>NA</td>
-<td>Measure</td>
-</tr>
-</tbody>
-</table>
-<ul>
-<li><strong>Put the frequently-used column filter in the beginning</strong></li>
-</ul>
-<p>For example, MSISDN filter is used in most of the query then we must put the MSISDN in the first column.
-The create table command can be modified as suggested below :</p>
-<pre><code>create table carbondata_table(
- msisdn String,
- BEGIN_TIME bigint,
- HOST String,
- Dime_1 String,
- counter_1, Decimal
- ...
-
- )STORED BY 'carbondata'
- TBLPROPERTIES ('SORT_COLUMNS'='msisdn, Dime_1')
-</code></pre>
-<p>Now the query with MSISDN in the filter will be more efficient.</p>
-<ul>
-<li><strong>Put the frequently-used columns in the order of low to high cardinality</strong></li>
-</ul>
-<p>If the table in the specified query has multiple columns which are frequently used to filter the results, it is suggested to put
-the columns in the order of cardinality low to high. This ordering of frequently used columns improves the compression ratio and
-enhances the performance of queries with filter on these columns.</p>
-<p>For example, if MSISDN, HOST and Dime_1 are frequently-used columns, then the column order of table is suggested as
-Dime_1>HOST>MSISDN, because Dime_1 has the lowest cardinality.
-The create table command can be modified as suggested below :</p>
-<pre><code>create table carbondata_table(
- msisdn String,
- BEGIN_TIME bigint,
- HOST String,
- Dime_1 String,
- counter_1, Decimal
- ...
-
- )STORED BY 'carbondata'
- TBLPROPERTIES ('SORT_COLUMNS'='Dime_1, HOST, MSISDN')
-</code></pre>
-<ul>
-<li><strong>For measure type columns with non high accuracy, replace Numeric(20,0) data type with Double data type</strong></li>
-</ul>
-<p>For columns of measure type, not requiring high accuracy, it is suggested to replace Numeric data type with Double to enhance query performance.
-The create table command can be modified as below :</p>
-<pre><code> create table carbondata_table(
- Dime_1 String,
- BEGIN_TIME bigint,
- END_TIME bigint,
- HOST String,
- MSISDN String,
- counter_1 decimal,
- counter_2 double,
- ...
- )STORED BY 'carbondata'
- TBLPROPERTIES ('SORT_COLUMNS'='Dime_1, HOST, MSISDN')
-</code></pre>
-<p>The result of performance analysis of test-case shows reduction in query execution time from 15 to 3 seconds, thereby improving performance by nearly 5 times.</p>
-<ul>
-<li><strong>Columns of incremental character should be re-arranged at the end of dimensions</strong></li>
-</ul>
-<p>Consider the following scenario where data is loaded each day and the begin_time is incremental for each load, it is suggested to put begin_time at the end of dimensions.
-Incremental values are efficient in using min/max index. The create table command can be modified as below :</p>
-<pre><code>create table carbondata_table(
- Dime_1 String,
- HOST String,
- MSISDN String,
- counter_1 double,
- counter_2 double,
- BEGIN_TIME bigint,
- END_TIME bigint,
- ...
- counter_100 double
- )STORED BY 'carbondata'
- TBLPROPERTIES ('SORT_COLUMNS'='Dime_1, HOST, MSISDN')
-</code></pre>
-<p><strong>NOTE:</strong></p>
-<ul>
-<li>BloomFilter can be created to enhance performance for queries with precise equal/in conditions. You can find more information about it in BloomFilter datamap <a href="https://github.com/apache/carbondata/blob/master/docs/datamap/bloomfilter-datamap-guide.html" target=_blank>document</a>.</li>
-</ul>
-<h2>
-<a id="configuration-for-optimizing-data-loading-performance-for-massive-data" class="anchor" href="#configuration-for-optimizing-data-loading-performance-for-massive-data" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Configuration for Optimizing Data Loading performance for Massive Data</h2>
-<p>CarbonData supports large data load, in this process sorting data while loading consumes a lot of memory and disk IO and
-this can result sometimes in "Out Of Memory" exception.
-If you do not have much memory to use, then you may prefer to slow the speed of data loading instead of data load failure.
-You can configure CarbonData by tuning following properties in carbon.properties file to get a better performance.</p>
-<table>
-<thead>
-<tr>
-<th>Parameter</th>
-<th>Default Value</th>
-<th>Description/Tuning</th>
-</tr>
-</thead>
-<tbody>
-<tr>
-<td>carbon.number.of.cores.while.loading</td>
-<td>Default: 2.This value should be >= 2</td>
-<td>Specifies the number of cores used for data processing during data loading in CarbonData.</td>
-</tr>
-<tr>
-<td>carbon.sort.size</td>
-<td>Default: 100000. The value should be >= 100.</td>
-<td>Threshold to write local file in sort step when loading data</td>
-</tr>
-<tr>
-<td>carbon.sort.file.write.buffer.size</td>
-<td>Default: 50000.</td>
-<td>DataOutputStream buffer.</td>
-</tr>
-<tr>
-<td>carbon.number.of.cores.block.sort</td>
-<td>Default: 7</td>
-<td>If you have huge memory and CPUs, increase it as you will</td>
-</tr>
-<tr>
-<td>carbon.merge.sort.reader.thread</td>
-<td>Default: 3</td>
-<td>Specifies the number of cores used for temp file merging during data loading in CarbonData.</td>
-</tr>
-<tr>
-<td>carbon.merge.sort.prefetch</td>
-<td>Default: true</td>
-<td>You may want set this value to false if you have not enough memory</td>
-</tr>
-</tbody>
-</table>
-<p>For example, if there are 10 million records, and i have only 16 cores, 64GB memory, will be loaded to CarbonData table.
-Using the default configuration always fail in sort step. Modify carbon.properties as suggested below:</p>
-<pre><code>carbon.number.of.cores.block.sort=1
-carbon.merge.sort.reader.thread=1
-carbon.sort.size=5000
-carbon.sort.file.write.buffer.size=5000
-carbon.merge.sort.prefetch=false
-</code></pre>
-<h2>
-<a id="configurations-for-optimizing-carbondata-performance" class="anchor" href="#configurations-for-optimizing-carbondata-performance" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Configurations for Optimizing CarbonData Performance</h2>
-<p>Recently we did some performance POC on CarbonData for Finance and telecommunication Field. It involved detailed queries and aggregation
-scenarios. After the completion of POC, some of the configurations impacting the performance have been identified and tabulated below :</p>
-<table>
-<thead>
-<tr>
-<th>Parameter</th>
-<th>Location</th>
-<th>Used For</th>
-<th>Description</th>
-<th>Tuning</th>
-</tr>
-</thead>
-<tbody>
-<tr>
-<td>carbon.sort.intermediate.files.limit</td>
-<td>spark/carbonlib/carbon.properties</td>
-<td>Data loading</td>
-<td>During the loading of data, local temp is used to sort the data. This number specifies the minimum number of intermediate files after which the merge sort has to be initiated.</td>
-<td>Increasing the parameter to a higher value will improve the load performance. For example, when we increase the value from 20 to 100, it increases the data load performance from 35MB/S to more than 50MB/S. Higher values of this parameter consumes more memory during the load.</td>
-</tr>
-<tr>
-<td>carbon.number.of.cores.while.loading</td>
-<td>spark/carbonlib/carbon.properties</td>
-<td>Data loading</td>
-<td>Specifies the number of cores used for data processing during data loading in CarbonData.</td>
-<td>If you have more number of CPUs, then you can increase the number of CPUs, which will increase the performance. For example if we increase the value from 2 to 4 then the CSV reading performance can increase about 1 times</td>
-</tr>
-<tr>
-<td>carbon.compaction.level.threshold</td>
-<td>spark/carbonlib/carbon.properties</td>
-<td>Data loading and Querying</td>
-<td>For minor compaction, specifies the number of segments to be merged in stage 1 and number of compacted segments to be merged in stage 2.</td>
-<td>Each CarbonData load will create one segment, if every load is small in size it will generate many small file over a period of time impacting the query performance. Configuring this parameter will merge the small segment to one big segment which will sort the data and improve the performance. For Example in one telecommunication scenario, the performance improves about 2 times after minor compaction.</td>
-</tr>
-<tr>
-<td>spark.sql.shuffle.partitions</td>
-<td>spark/conf/spark-defaults.conf</td>
-<td>Querying</td>
-<td>The number of task started when spark shuffle.</td>
-<td>The value can be 1 to 2 times as much as the executor cores. In an aggregation scenario, reducing the number from 200 to 32 reduced the query time from 17 to 9 seconds.</td>
-</tr>
-<tr>
-<td>spark.executor.instances/spark.executor.cores/spark.executor.memory</td>
-<td>spark/conf/spark-defaults.conf</td>
-<td>Querying</td>
-<td>The number of executors, CPU cores, and memory used for CarbonData query.</td>
-<td>In the bank scenario, we provide the 4 CPUs cores and 15 GB for each executor which can get good performance. This 2 value does not mean more the better. It needs to be configured properly in case of limited resources. For example, In the bank scenario, it has enough CPU 32 cores each node but less memory 64 GB each node. So we cannot give more CPU but less memory. For example, when 4 cores and 12GB for each executor. It sometimes happens GC during the query which impact the query performance very much from the 3 second to more than 15 seconds. In this scenario need to increase the memory or decrease the CPU cores.</td>
-</tr>
-<tr>
-<td>carbon.detail.batch.size</td>
-<td>spark/carbonlib/carbon.properties</td>
-<td>Data loading</td>
-<td>The buffer size to store records, returned from the block scan.</td>
-<td>In limit scenario this parameter is very important. For example your query limit is 1000. But if we set this value to 3000 that means we get 3000 records from scan but spark will only take 1000 rows. So the 2000 remaining are useless. In one Finance test case after we set it to 100, in the limit 1000 scenario the performance increase about 2 times in comparison to if we set this value to 12000.</td>
-</tr>
-<tr>
-<td>carbon.use.local.dir</td>
-<td>spark/carbonlib/carbon.properties</td>
-<td>Data loading</td>
-<td>Whether use YARN local directories for multi-table load disk load balance</td>
-<td>If this is set it to true CarbonData will use YARN local directories for multi-table load disk load balance, that will improve the data load performance.</td>
-</tr>
-<tr>
-<td>carbon.use.multiple.temp.dir</td>
-<td>spark/carbonlib/carbon.properties</td>
-<td>Data loading</td>
-<td>Whether to use multiple YARN local directories during table data loading for disk load balance</td>
-<td>After enabling 'carbon.use.local.dir', if this is set to true, CarbonData will use all YARN local directories during data load for disk load balance, that will improve the data load performance. Please enable this property when you encounter disk hotspot problem during data loading.</td>
-</tr>
-<tr>
-<td>carbon.sort.temp.compressor</td>
-<td>spark/carbonlib/carbon.properties</td>
-<td>Data loading</td>
-<td>Specify the name of compressor to compress the intermediate sort temporary files during sort procedure in data loading.</td>
-<td>The optional values are 'SNAPPY','GZIP','BZIP2','LZ4','ZSTD' and empty. By default, empty means that Carbondata will not compress the sort temp files. This parameter will be useful if you encounter disk bottleneck.</td>
-</tr>
-<tr>
-<td>carbon.load.skewedDataOptimization.enabled</td>
-<td>spark/carbonlib/carbon.properties</td>
-<td>Data loading</td>
-<td>Whether to enable size based block allocation strategy for data loading.</td>
-<td>When loading, carbondata will use file size based block allocation strategy for task distribution. It will make sure that all the executors process the same size of data -- It's useful if the size of your input data files varies widely, say 1MB~1GB.</td>
-</tr>
-<tr>
-<td>carbon.load.min.size.enabled</td>
-<td>spark/carbonlib/carbon.properties</td>
-<td>Data loading</td>
-<td>Whether to enable node minumun input data size allocation strategy for data loading.</td>
-<td>When loading, carbondata will use node minumun input data size allocation strategy for task distribution. It will make sure the node load the minimum amount of data -- It's useful if the size of your input data files very small, say 1MB~256MB,Avoid generating a large number of small files.</td>
-</tr>
-</tbody>
-</table>
-<p>Note: If your CarbonData instance is provided only for query, you may specify the property 'spark.speculation=true' which is in conf directory of spark.</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/src/main/resources/application.conf
----------------------------------------------------------------------
diff --git a/src/main/resources/application.conf b/src/main/resources/application.conf
index ba425e5..020b127 100644
--- a/src/main/resources/application.conf
+++ b/src/main/resources/application.conf
@@ -16,7 +16,9 @@ fileList=["configuration-parameters",
"release-guide",
"how-to-contribute-to-apache-carbondata",
"introduction",
- "usecases"
+ "usecases",
+ "CSDK-guide",
+ "carbon-as-spark-datasource-guide"
]
dataMapFileList=[
"bloomfilter-datamap-guide",
http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6ad7599a/src/main/scala/MdFileHandler.scala
----------------------------------------------------------------------
diff --git a/src/main/scala/MdFileHandler.scala b/src/main/scala/MdFileHandler.scala
index 148a280..255bdf3 100644
--- a/src/main/scala/MdFileHandler.scala
+++ b/src/main/scala/MdFileHandler.scala
@@ -28,7 +28,7 @@ class MdFileHandler @Inject()(confService: ConfService, fileService: FileService
val contentAfterReplacingDatamap: String = modifyDatamapPattern replaceAllIn(contentAfterReplacingId, "./")
- val contentAfterReplacingImage: String = modifyImagePattern replaceAllIn(contentAfterReplacingDatamap,replacingImageContent)
+ val contentAfterReplacingImage: String = modifyImagePattern replaceAllIn(contentAfterReplacingDatamap, replacingImageContent)
val contentAfterReplacingHttpsFileLink: String = modifyHttpsFileLink replaceAllIn(contentAfterReplacingImage, "$1://$2$3 target=_blank")
val contentAfterReplacingFileLink: String = modifyHttpFileLink replaceAllIn(contentAfterReplacingHttpsFileLink, "$1://$2$3 target=_blank")
contentAfterReplacingFileLink
http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6ad7599a/src/main/scala/html/header.html
----------------------------------------------------------------------
diff --git a/src/main/scala/html/header.html b/src/main/scala/html/header.html
index 217a9f4..93229f6 100644
--- a/src/main/scala/html/header.html
+++ b/src/main/scala/html/header.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>
http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6ad7599a/src/main/scala/scripts/CSDK-guide
----------------------------------------------------------------------
diff --git a/src/main/scala/scripts/CSDK-guide b/src/main/scala/scripts/CSDK-guide
new file mode 100644
index 0000000..2c8ffc0
--- /dev/null
+++ b/src/main/scala/scripts/CSDK-guide
@@ -0,0 +1,11 @@
+<script>
+$(function() {
+ // Show selected style on nav item
+ $('.b-nav__api').addClass('selected');
+
+ if (!$('.b-nav__api').parent().hasClass('nav__item__with__subs--expanded')) {
+ // Display api subnav items
+ $('.b-nav__api').parent().toggleClass('nav__item__with__subs--expanded');
+ }
+});
+</script>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6ad7599a/src/main/scala/scripts/carbon-as-spark-datasource-guide
----------------------------------------------------------------------
diff --git a/src/main/scala/scripts/carbon-as-spark-datasource-guide b/src/main/scala/scripts/carbon-as-spark-datasource-guide
new file mode 100644
index 0000000..3d168cd
--- /dev/null
+++ b/src/main/scala/scripts/carbon-as-spark-datasource-guide
@@ -0,0 +1,11 @@
+<script>
+$(function() {
+ // Show selected style on nav item
+ $('.b-nav__docs').addClass('selected');
+
+ // Display docs subnav items
+ if (!$('.b-nav__docs').parent().hasClass('nav__item__with__subs--expanded')) {
+ $('.b-nav__docs').parent().toggleClass('nav__item__with__subs--expanded');
+ }
+});
+</script>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6ad7599a/src/main/scala/scripts/sdk-guide
----------------------------------------------------------------------
diff --git a/src/main/scala/scripts/sdk-guide b/src/main/scala/scripts/sdk-guide
index 700185a..2c8ffc0 100644
--- a/src/main/scala/scripts/sdk-guide
+++ b/src/main/scala/scripts/sdk-guide
@@ -1,4 +1,11 @@
<script>
-// Show selected style on nav item
-$(function() { $('.b-nav__api').addClass('selected'); });
+$(function() {
+ // Show selected style on nav item
+ $('.b-nav__api').addClass('selected');
+
+ if (!$('.b-nav__api').parent().hasClass('nav__item__with__subs--expanded')) {
+ // Display api subnav items
+ $('.b-nav__api').parent().toggleClass('nav__item__with__subs--expanded');
+ }
+});
</script>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6ad7599a/src/main/webapp/CSDK-guide.html
----------------------------------------------------------------------
diff --git a/src/main/webapp/CSDK-guide.html b/src/main/webapp/CSDK-guide.html
new file mode 100644
index 0000000..193d74f
--- /dev/null
+++ b/src/main/webapp/CSDK-guide.html
@@ -0,0 +1,422 @@
+<!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>
+ <script defer src="https://use.fontawesome.com/releases/v5.0.8/js/all.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.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>
+ <a href="https://dist.apache.org/repos/dist/release/carbondata/1.4.0/"
+ target="_blank">Apache CarbonData 1.4.0</a></li>
+ <li>
+ <a href="https://dist.apache.org/repos/dist/release/carbondata/1.3.1/"
+ target="_blank">Apache CarbonData 1.3.1</a></li>
+ <li>
+ <a href="https://dist.apache.org/repos/dist/release/carbondata/1.3.0/"
+ target="_blank">Apache CarbonData 1.3.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="documentation.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="verticalnavbar">
+ <nav class="b-sticky-nav">
+ <div class="nav-scroller">
+ <div class="nav__inner">
+ <a class="b-nav__intro nav__item" href="./introduction.html">introduction</a>
+ <a class="b-nav__quickstart nav__item" href="./quick-start-guide.html">quick start</a>
+ <a class="b-nav__uses nav__item" href="./usecases.html">use cases</a>
+
+ <div class="nav__item nav__item__with__subs">
+ <a class="b-nav__docs nav__item nav__sub__anchor" href="./language-manual.html">Language Reference</a>
+ <a class="nav__item nav__sub__item" href="./ddl-of-carbondata.html">DDL</a>
+ <a class="nav__item nav__sub__item" href="./dml-of-carbondata.html">DML</a>
+ <a class="nav__item nav__sub__item" href="./streaming-guide.html">Streaming</a>
+ <a class="nav__item nav__sub__item" href="./configuration-parameters.html">Configuration</a>
+ <a class="nav__item nav__sub__item" href="./datamap-developer-guide.html">Datamaps</a>
+ <a class="nav__item nav__sub__item" href="./supported-data-types-in-carbondata.html">Data Types</a>
+ </div>
+
+ <div class="nav__item nav__item__with__subs">
+ <a class="b-nav__datamap nav__item nav__sub__anchor" href="./datamap-management.html">DataMaps</a>
+ <a class="nav__item nav__sub__item" href="./bloomfilter-datamap-guide.html">Bloom Filter</a>
+ <a class="nav__item nav__sub__item" href="./lucene-datamap-guide.html">Lucene</a>
+ <a class="nav__item nav__sub__item" href="./preaggregate-datamap-guide.html">Pre-Aggregate</a>
+ <a class="nav__item nav__sub__item" href="./timeseries-datamap-guide.html">Time Series</a>
+ </div>
+
+ <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>
+ <a class="b-nav__contri nav__item" href="./how-to-contribute-to-apache-carbondata.html">Contribute</a>
+ <a class="b-nav__security nav__item" href="./security.html">Security</a>
+ <a class="b-nav__release nav__item" href="./release-guide.html">Release Guide</a>
+ </div>
+ </div>
+ <div class="navindicator">
+ <div class="b-nav__intro navindicator__item"></div>
+ <div class="b-nav__quickstart navindicator__item"></div>
+ <div class="b-nav__uses navindicator__item"></div>
+ <div class="b-nav__docs navindicator__item"></div>
+ <div class="b-nav__datamap navindicator__item"></div>
+ <div class="b-nav__api navindicator__item"></div>
+ <div class="b-nav__perf navindicator__item"></div>
+ <div class="b-nav__s3 navindicator__item"></div>
+ <div class="b-nav__faq navindicator__item"></div>
+ <div class="b-nav__contri navindicator__item"></div>
+ <div class="b-nav__security navindicator__item"></div>
+ </div>
+ </nav>
+ </div>
+ <div class="mdcontent">
+ <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="csdk-guide" class="anchor" href="#csdk-guide" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>CSDK Guide</h1>
+<p>CarbonData CSDK provides C++ interface to write and read carbon file.
+CSDK use JNI to invoke java SDK in C++ code.</p>
+<h1>
+<a id="csdk-reader" class="anchor" href="#csdk-reader" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>CSDK Reader</h1>
+<p>This CSDK reader reads CarbonData file and carbonindex file at a given path.
+External client can make use of this reader to read CarbonData files in C++
+code and without CarbonSession.</p>
+<p>In the carbon jars package, there exist a carbondata-sdk.jar,
+including SDK reader for CSDK.</p>
+<h2>
+<a id="quick-example" class="anchor" href="#quick-example" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Quick example</h2>
+<pre><code>// 1. init JVM
+JavaVM *jvm;
+JNIEnv *initJVM() {
+ JNIEnv *env;
+ JavaVMInitArgs vm_args;
+ int parNum = 3;
+ int res;
+ JavaVMOption options[parNum];
+
+ options[0].optionString = "-Djava.compiler=NONE";
+ options[1].optionString = "-Djava.class.path=../../sdk/target/carbondata-sdk.jar";
+ options[2].optionString = "-verbose:jni";
+ vm_args.version = JNI_VERSION_1_8;
+ vm_args.nOptions = parNum;
+ vm_args.options = options;
+ vm_args.ignoreUnrecognized = JNI_FALSE;
+
+ res = JNI_CreateJavaVM(&jvm, (void **) &env, &vm_args);
+ if (res < 0) {
+ fprintf(stderr, "\nCan't create Java VM\n");
+ exit(1);
+ }
+
+ return env;
+}
+
+// 2. create carbon reader and read data
+// 2.1 read data from local disk
+/**
+ * test read data from local disk, without projection
+ *
+ * @param env jni env
+ * @return
+ */
+bool readFromLocalWithoutProjection(JNIEnv *env) {
+
+ CarbonReader carbonReaderClass;
+ carbonReaderClass.builder(env, "../resources/carbondata", "test");
+ carbonReaderClass.build();
+
+ while (carbonReaderClass.hasNext()) {
+ jobjectArray row = carbonReaderClass.readNextRow();
+ jsize length = env->GetArrayLength(row);
+ int j = 0;
+ for (j = 0; j < length; j++) {
+ jobject element = env->GetObjectArrayElement(row, j);
+ char *str = (char *) env->GetStringUTFChars((jstring) element, JNI_FALSE);
+ printf("%s\t", str);
+ }
+ printf("\n");
+ }
+ carbonReaderClass.close();
+}
+
+// 2.2 read data from S3
+
+/**
+ * read data from S3
+ * parameter is ak sk endpoint
+ *
+ * @param env jni env
+ * @param argv argument vector
+ * @return
+ */
+bool readFromS3(JNIEnv *env, char *argv[]) {
+ CarbonReader reader;
+
+ char *args[3];
+ // "your access key"
+ args[0] = argv[1];
+ // "your secret key"
+ args[1] = argv[2];
+ // "your endPoint"
+ args[2] = argv[3];
+
+ reader.builder(env, "s3a://sdk/WriterOutput", "test");
+ reader.withHadoopConf(3, args);
+ reader.build();
+ printf("\nRead data from S3:\n");
+ while (reader.hasNext()) {
+ jobjectArray row = reader.readNextRow();
+ jsize length = env->GetArrayLength(row);
+
+ int j = 0;
+ for (j = 0; j < length; j++) {
+ jobject element = env->GetObjectArrayElement(row, j);
+ char *str = (char *) env->GetStringUTFChars((jstring) element, JNI_FALSE);
+ printf("%s\t", str);
+ }
+ printf("\n");
+ }
+
+ reader.close();
+}
+
+// 3. destory JVM
+ (jvm)->DestroyJavaVM();
+</code></pre>
+<p>Find example code at main.cpp of CSDK module</p>
+<h2>
+<a id="api-list" class="anchor" href="#api-list" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>API List</h2>
+<pre><code> /**
+ * create a CarbonReaderBuilder object for building carbonReader,
+ * CarbonReaderBuilder object can configure different parameter
+ *
+ * @param env JNIEnv
+ * @param path data store path
+ * @param tableName table name
+ * @return CarbonReaderBuilder object
+ */
+ jobject builder(JNIEnv *env, char *path, char *tableName);
+
+ /**
+ * Configure the projection column names of carbon reader
+ *
+ * @param argc argument counter
+ * @param argv argument vector
+ * @return CarbonReaderBuilder object
+ */
+ jobject projection(int argc, char *argv[]);
+
+ /**
+ * build carbon reader with argument vector
+ * it support multiple parameter
+ * like: key=value
+ * for example: fs.s3a.access.key=XXXX, XXXX is user's access key value
+ *
+ * @param argc argument counter
+ * @param argv argument vector
+ * @return CarbonReaderBuilder object
+ **/
+ jobject withHadoopConf(int argc, char *argv[]);
+
+ /**
+ * build carbonReader object for reading data
+ * it support read data from load disk
+ *
+ * @return carbonReader object
+ */
+ jobject build();
+
+ /**
+ * Whether it has next row data
+ *
+ * @return boolean value, if it has next row, return true. if it hasn't next row, return false.
+ */
+ jboolean hasNext();
+
+ /**
+ * read next row from data
+ *
+ * @return object array of one row
+ */
+ jobjectArray readNextRow();
+
+ /**
+ * close the carbon reader
+ *
+ * @return boolean value
+ */
+ jboolean close();
+
+</code></pre>
+<script>
+$(function() {
+ // Show selected style on nav item
+ $('.b-nav__api').addClass('selected');
+
+ if (!$('.b-nav__api').parent().hasClass('nav__item__with__subs--expanded')) {
+ // Display api subnav items
+ $('.b-nav__api').parent().toggleClass('nav__item__with__subs--expanded');
+ }
+});
+</script></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/src/main/webapp/bloomfilter-datamap-guide.html
----------------------------------------------------------------------
diff --git a/src/main/webapp/bloomfilter-datamap-guide.html b/src/main/webapp/bloomfilter-datamap-guide.html
index 8030599..2ecfa44 100644
--- a/src/main/webapp/bloomfilter-datamap-guide.html
+++ b/src/main/webapp/bloomfilter-datamap-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>
@@ -211,7 +219,7 @@
<div class="col-sm-12 col-md-12">
<div>
<h1>
-<a id="carbondata-bloomfilter-datamap-alpha-feature" class="anchor" href="#carbondata-bloomfilter-datamap-alpha-feature" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>CarbonData BloomFilter DataMap (Alpha Feature)</h1>
+<a id="carbondata-bloomfilter-datamap" class="anchor" href="#carbondata-bloomfilter-datamap" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>CarbonData BloomFilter DataMap</h1>
<ul>
<li><a href="#datamap-management">DataMap Management</a></li>
<li><a href="#bloomfilter-datamap-introduction">BloomFilter Datamap Introduction</a></li>
@@ -238,7 +246,7 @@ ON TABLE main_table
</code></pre>
<p>Disable Datamap</p>
<blockquote>
-<p>The datamap by default is enabled. To support tuning on query, we can disable a specific datamap during query to observe whether we can gain performance enhancement from it. This will only take effect current session.</p>
+<p>The datamap by default is enabled. To support tuning on query, we can disable a specific datamap during query to observe whether we can gain performance enhancement from it. This is effective only for current session.</p>
</blockquote>
<pre><code>// disable the datamap
SET carbon.datamap.visible.dbName.tableName.dataMapName = false
@@ -268,7 +276,7 @@ and we always query on <code>id</code> and <code>name</code> with precise value.
since <code>id</code> is in the sort_columns and it is orderd,
query on it will be fast because CarbonData can skip all the irrelative blocklets.
But queries on <code>name</code> may be bad since the blocklet minmax may not help,
-because in each blocklet the range of the value of <code>name</code> may be the same -- all from A<em>~z</em>.
+because in each blocklet the range of the value of <code>name</code> may be the same -- all from A* to z*.
In this case, user can create a BloomFilter datamap on column <code>name</code>.
Moreover, user can also create a BloomFilter datamap on the sort_columns.
This is useful if user has too many segments and the range of the value of sort_columns are almost the same.</p>
[10/20] carbondata-site git commit: modified for 1.5.0 version
Posted by ch...@apache.org.
http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6ad7599a/content/file-structure-of-carbondata.html
----------------------------------------------------------------------
diff --git a/content/file-structure-of-carbondata.html b/content/file-structure-of-carbondata.html
index c14ea6d..bd2be65 100644
--- a/content/file-structure-of-carbondata.html
+++ b/content/file-structure-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>
@@ -249,7 +257,7 @@
<p>The file directory structure is as below:</p>
<p><a href="../docs/images/2-1_1.png?raw=true" target="_blank" rel="noopener noreferrer"><img src="https://github.com/apache/carbondata/blob/master/docs/images/2-1_1.png?raw=true" alt="File Directory Structure" style="max-width:100%;"></a></p>
<ol>
-<li>ModifiedTime.htmlt records the timestamp of the metadata with the modification time attribute of the file. When the drop table and create table are used, the modification time of the file is updated.This is common to all databases and hence is kept in parallel to databases</li>
+<li>ModifiedTime.htmlt records the timestamp of the metadata with the modification time attribute of the file. When the drop table and create table are used, the modification time of the file is updated. This is common to all databases and hence is kept in parallel to databases</li>
<li>The <strong>default</strong> is the database name and contains the user tables.default is used when user doesn't specify any database name;else user configured database name will be the directory name. user_table is the table name.</li>
<li>Metadata directory stores schema files, tablestatus and dictionary files (including .dict, .dictmeta and .sortindex). There are three types of metadata data information files.</li>
<li>data and index files are stored under directory named <strong>Fact</strong>. The Fact directory has a Part0 partition directory, where 0 is the partition number.</li>
http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6ad7599a/content/how-to-contribute-to-apache-carbondata.html
----------------------------------------------------------------------
diff --git a/content/how-to-contribute-to-apache-carbondata.html b/content/how-to-contribute-to-apache-carbondata.html
index 122b763..392814c 100644
--- a/content/how-to-contribute-to-apache-carbondata.html
+++ b/content/how-to-contribute-to-apache-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>
@@ -238,7 +246,7 @@ create it. Please discuss your proposal with a committer or the component lead i
alternatively, on the developer mailing list(<a href="mailto:dev@carbondata.apache.org">dev@carbondata.apache.org</a>).</p>
<p>If there?s an existing JIRA issue for your intended contribution, please comment about your
intended work. Once the work is understood, a committer will assign the issue to you.
-(If you don?t have a JIRA role yet, you?ll be added to the ?contributor? role.) If an issue is
+(If you don?t have a JIRA role yet, you?ll be added to the "contributor" role.) If an issue is
currently assigned, please check with the current assignee before reassigning.</p>
<p>For moderate or large contributions, you should not start coding or writing a design doc unless
there is a corresponding JIRA issue assigned to you for that work. Simple changes,
@@ -334,7 +342,7 @@ When you make a revision, always push it in a new commit.</p>
Please make sure those tests pass,the contribution cannot be merged otherwise.</p>
<h4>
<a id="lgtm" class="anchor" href="#lgtm" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>LGTM</h4>
-<p>Once the reviewer is happy with the change, they?ll respond with an LGTM (?looks good to me!?).
+<p>Once the reviewer is happy with the change, they?ll respond with an LGTM ("looks good to me!").
At this point, the committer will take over, possibly make some additional touch ups,
and merge your changes into the codebase.</p>
<p>In the case both the author and the reviewer are committers, either can merge the pull request.
http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6ad7599a/content/index.html
----------------------------------------------------------------------
diff --git a/content/index.html b/content/index.html
index f059d16..5c5b663 100644
--- a/content/index.html
+++ b/content/index.html
@@ -54,6 +54,9 @@
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>
@@ -310,6 +313,13 @@
</h4>
<div class="linkblock">
<div class="block-row">
+ <a href="https://dist.apache.org/repos/dist/release/carbondata/1.5.0/"
+ target="_blank">Apache CarbonData 1.5.0</a>
+ <span class="release-date">Oct 2018</span>
+ <a href="https://cwiki.apache.org/confluence/display/CARBONDATA/Apache+CarbonData+1.5.0+Release"
+ class="whatsnew" target="_blank">what's new</a>
+ </div>
+ <div class="block-row">
<a href="https://dist.apache.org/repos/dist/release/carbondata/1.4.1/"
target="_blank">Apache CarbonData 1.4.1</a>
<span class="release-date">Aug 2018</span>
@@ -468,7 +478,7 @@
to do is:</p>
<ol class="orderlist">
<li>
- <a href="https://dist.apache.org/repos/dist/release/carbondata/1.4.1/"
+ <a href="https://dist.apache.org/repos/dist/release/carbondata/1.5.0/"
target="_blank">Download</a>the latest release.
</li>
http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6ad7599a/content/installation-guide.html
----------------------------------------------------------------------
diff --git a/content/installation-guide.html b/content/installation-guide.html
deleted file mode 100644
index 2e7fab6..0000000
--- a/content/installation-guide.html
+++ /dev/null
@@ -1,455 +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.4.1/"
- target="_blank">Apache CarbonData 1.4.1</a></li>
- <li>
- <a href="https://dist.apache.org/repos/dist/release/carbondata/1.4.0/"
- target="_blank">Apache CarbonData 1.4.0</a></li>
- <li>
- <a href="https://dist.apache.org/repos/dist/release/carbondata/1.3.1/"
- target="_blank">Apache CarbonData 1.3.1</a></li>
- <li>
- <a href="https://dist.apache.org/repos/dist/release/carbondata/1.3.0/"
- target="_blank">Apache CarbonData 1.3.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="installation-guide" class="anchor" href="#installation-guide" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Installation Guide</h1>
-<p>This tutorial guides you through the installation and configuration of CarbonData in the following two modes :</p>
-<ul>
-<li><a href="#installing-and-configuring-carbondata-on-standalone-spark-cluster">Installing and Configuring CarbonData on Standalone Spark Cluster</a></li>
-<li><a href="#installing-and-configuring-carbondata-on-spark-on-yarn-cluster">Installing and Configuring CarbonData on Spark on YARN Cluster</a></li>
-</ul>
-<p>followed by :</p>
-<ul>
-<li><a href="#query-execution-using-carbondata-thrift-server">Query Execution using CarbonData Thrift Server</a></li>
-</ul>
-<h2>
-<a id="installing-and-configuring-carbondata-on-standalone-spark-cluster" class="anchor" href="#installing-and-configuring-carbondata-on-standalone-spark-cluster" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Installing and Configuring CarbonData on Standalone Spark Cluster</h2>
-<h3>
-<a id="prerequisites" class="anchor" href="#prerequisites" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Prerequisites</h3>
-<ul>
-<li>
-<p>Hadoop HDFS and Yarn should be installed and running.</p>
-</li>
-<li>
-<p>Spark should be installed and running on all the cluster nodes.</p>
-</li>
-<li>
-<p>CarbonData user should have permission to access HDFS.</p>
-</li>
-</ul>
-<h3>
-<a id="procedure" class="anchor" href="#procedure" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Procedure</h3>
-<ol>
-<li>
-<p><a href="https://github.com/apache/carbondata/blob/master/build/README.md" target=_blank>Build the CarbonData</a> project and get the assembly jar from <code>./assembly/target/scala-2.1x/carbondata_xxx.jar</code>.</p>
-</li>
-<li>
-<p>Copy <code>./assembly/target/scala-2.1x/carbondata_xxx.jar</code> to <code>$SPARK_HOME/carbonlib</code> folder.</p>
-<p><strong>NOTE</strong>: Create the carbonlib folder if it does not exist inside <code>$SPARK_HOME</code> path.</p>
-</li>
-<li>
-<p>Add the carbonlib folder path in the Spark classpath. (Edit <code>$SPARK_HOME/conf/spark-env.sh</code> file and modify the value of <code>SPARK_CLASSPATH</code> by appending <code>$SPARK_HOME/carbonlib/*</code> to the existing value)</p>
-</li>
-<li>
-<p>Copy the <code>./conf/carbon.properties.template</code> file from CarbonData repository to <code>$SPARK_HOME/conf/</code> folder and rename the file to <code>carbon.properties</code>.</p>
-</li>
-<li>
-<p>Repeat Step 2 to Step 5 in all the nodes of the cluster.</p>
-</li>
-<li>
-<p>In Spark node[master], configure the properties mentioned in the following table in <code>$SPARK_HOME/conf/spark-defaults.conf</code> file.</p>
-</li>
-</ol>
-<table>
-<thead>
-<tr>
-<th>Property</th>
-<th>Value</th>
-<th>Description</th>
-</tr>
-</thead>
-<tbody>
-<tr>
-<td>spark.driver.extraJavaOptions</td>
-<td><code>-Dcarbon.properties.filepath = $SPARK_HOME/conf/carbon.properties</code></td>
-<td>A string of extra JVM options to pass to the driver. For instance, GC settings or other logging.</td>
-</tr>
-<tr>
-<td>spark.executor.extraJavaOptions</td>
-<td><code>-Dcarbon.properties.filepath = $SPARK_HOME/conf/carbon.properties</code></td>
-<td>A string of extra JVM options to pass to executors. For instance, GC settings or other logging. <strong>NOTE</strong>: You can enter multiple values separated by space.</td>
-</tr>
-</tbody>
-</table>
-<ol start="7">
-<li>Add the following properties in <code>$SPARK_HOME/conf/carbon.properties</code> file:</li>
-</ol>
-<table>
-<thead>
-<tr>
-<th>Property</th>
-<th>Required</th>
-<th>Description</th>
-<th>Example</th>
-<th>Remark</th>
-</tr>
-</thead>
-<tbody>
-<tr>
-<td>carbon.storelocation</td>
-<td>NO</td>
-<td>Location where data CarbonData will create the store and write the data in its own format. If not specified then it takes spark.sql.warehouse.dir path.</td>
-<td>hdfs://HOSTNAME:PORT/Opt/CarbonStore</td>
-<td>Propose to set HDFS directory</td>
-</tr>
-</tbody>
-</table>
-<ol start="8">
-<li>Verify the installation. For example:</li>
-</ol>
-<pre><code>./spark-shell --master spark://HOSTNAME:PORT --total-executor-cores 2
---executor-memory 2G
-</code></pre>
-<p><strong>NOTE</strong>: Make sure you have permissions for CarbonData JARs and files through which driver and executor will start.</p>
-<p>To get started with CarbonData : <a href="quick-start-guide.html">Quick Start</a>, <a href="data-management-on-carbondata.html">Data Management on CarbonData</a></p>
-<h2>
-<a id="installing-and-configuring-carbondata-on-spark-on-yarn-cluster" class="anchor" href="#installing-and-configuring-carbondata-on-spark-on-yarn-cluster" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Installing and Configuring CarbonData on Spark on YARN Cluster</h2>
-<p>This section provides the procedure to install CarbonData on "Spark on YARN" cluster.</p>
-<h3>
-<a id="prerequisites-1" class="anchor" href="#prerequisites-1" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Prerequisites</h3>
-<ul>
-<li>Hadoop HDFS and Yarn should be installed and running.</li>
-<li>Spark should be installed and running in all the clients.</li>
-<li>CarbonData user should have permission to access HDFS.</li>
-</ul>
-<h3>
-<a id="procedure-1" class="anchor" href="#procedure-1" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Procedure</h3>
-<p>The following steps are only for Driver Nodes. (Driver nodes are the one which starts the spark context.)</p>
-<ol>
-<li>
-<p><a href="https://github.com/apache/carbondata/blob/master/build/README.md" target=_blank>Build the CarbonData</a> project and get the assembly jar from <code>./assembly/target/scala-2.1x/carbondata_xxx.jar</code> and copy to <code>$SPARK_HOME/carbonlib</code> folder.</p>
-<p><strong>NOTE</strong>: Create the carbonlib folder if it does not exists inside <code>$SPARK_HOME</code> path.</p>
-</li>
-<li>
-<p>Copy the <code>./conf/carbon.properties.template</code> file from CarbonData repository to <code>$SPARK_HOME/conf/</code> folder and rename the file to <code>carbon.properties</code>.</p>
-</li>
-<li>
-<p>Create <code>tar.gz</code> file of carbonlib folder and move it inside the carbonlib folder.</p>
-</li>
-</ol>
-<pre><code>cd $SPARK_HOME
-tar -zcvf carbondata.tar.gz carbonlib/
-mv carbondata.tar.gz carbonlib/
-</code></pre>
-<ol start="4">
-<li>Configure the properties mentioned in the following table in <code>$SPARK_HOME/conf/spark-defaults.conf</code> file.</li>
-</ol>
-<table>
-<thead>
-<tr>
-<th>Property</th>
-<th>Description</th>
-<th>Value</th>
-</tr>
-</thead>
-<tbody>
-<tr>
-<td>spark.master</td>
-<td>Set this value to run the Spark in yarn cluster mode.</td>
-<td>Set yarn-client to run the Spark in yarn cluster mode.</td>
-</tr>
-<tr>
-<td>spark.yarn.dist.files</td>
-<td>Comma-separated list of files to be placed in the working directory of each executor.</td>
-<td><code>$SPARK_HOME/conf/carbon.properties</code></td>
-</tr>
-<tr>
-<td>spark.yarn.dist.archives</td>
-<td>Comma-separated list of archives to be extracted into the working directory of each executor.</td>
-<td><code>$SPARK_HOME/carbonlib/carbondata.tar.gz</code></td>
-</tr>
-<tr>
-<td>spark.executor.extraJavaOptions</td>
-<td>A string of extra JVM options to pass to executors. For instance <strong>NOTE</strong>: You can enter multiple values separated by space.</td>
-<td><code>-Dcarbon.properties.filepath = carbon.properties</code></td>
-</tr>
-<tr>
-<td>spark.executor.extraClassPath</td>
-<td>Extra classpath entries to prepend to the classpath of executors. <strong>NOTE</strong>: If SPARK_CLASSPATH is defined in spark-env.sh, then comment it and append the values in below parameter spark.driver.extraClassPath</td>
-<td><code>carbondata.tar.gz/carbonlib/*</code></td>
-</tr>
-<tr>
-<td>spark.driver.extraClassPath</td>
-<td>Extra classpath entries to prepend to the classpath of the driver. <strong>NOTE</strong>: If SPARK_CLASSPATH is defined in spark-env.sh, then comment it and append the value in below parameter spark.driver.extraClassPath.</td>
-<td><code>$SPARK_HOME/carbonlib/*</code></td>
-</tr>
-<tr>
-<td>spark.driver.extraJavaOptions</td>
-<td>A string of extra JVM options to pass to the driver. For instance, GC settings or other logging.</td>
-<td><code>-Dcarbon.properties.filepath = $SPARK_HOME/conf/carbon.properties</code></td>
-</tr>
-</tbody>
-</table>
-<ol start="5">
-<li>Add the following properties in <code>$SPARK_HOME/conf/carbon.properties</code>:</li>
-</ol>
-<table>
-<thead>
-<tr>
-<th>Property</th>
-<th>Required</th>
-<th>Description</th>
-<th>Example</th>
-<th>Default Value</th>
-</tr>
-</thead>
-<tbody>
-<tr>
-<td>carbon.storelocation</td>
-<td>NO</td>
-<td>Location where CarbonData will create the store and write the data in its own format. If not specified then it takes spark.sql.warehouse.dir path.</td>
-<td>hdfs://HOSTNAME:PORT/Opt/CarbonStore</td>
-<td>Propose to set HDFS directory</td>
-</tr>
-</tbody>
-</table>
-<ol start="6">
-<li>Verify the installation.</li>
-</ol>
-<pre><code> ./bin/spark-shell --master yarn-client --driver-memory 1g
- --executor-cores 2 --executor-memory 2G
-</code></pre>
-<p><strong>NOTE</strong>: Make sure you have permissions for CarbonData JARs and files through which driver and executor will start.</p>
-<p>Getting started with CarbonData : <a href="quick-start-guide.html">Quick Start</a>, <a href="data-management-on-carbondata.html">Data Management on CarbonData</a></p>
-<h2>
-<a id="query-execution-using-carbondata-thrift-server" class="anchor" href="#query-execution-using-carbondata-thrift-server" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Query Execution Using CarbonData Thrift Server</h2>
-<h3>
-<a id="starting-carbondata-thrift-server" class="anchor" href="#starting-carbondata-thrift-server" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Starting CarbonData Thrift Server.</h3>
-<p>a. cd <code>$SPARK_HOME</code></p>
-<p>b. Run the following command to start the CarbonData thrift server.</p>
-<pre><code>./bin/spark-submit
---class org.apache.carbondata.spark.thriftserver.CarbonThriftServer
-$SPARK_HOME/carbonlib/$CARBON_ASSEMBLY_JAR <carbon_store_path>
-</code></pre>
-<table>
-<thead>
-<tr>
-<th>Parameter</th>
-<th>Description</th>
-<th>Example</th>
-</tr>
-</thead>
-<tbody>
-<tr>
-<td>CARBON_ASSEMBLY_JAR</td>
-<td>CarbonData assembly jar name present in the <code>$SPARK_HOME/carbonlib/</code> folder.</td>
-<td>carbondata_2.xx-x.x.x-SNAPSHOT-shade-hadoop2.7.2.jar</td>
-</tr>
-<tr>
-<td>carbon_store_path</td>
-<td>This is a parameter to the CarbonThriftServer class. This a HDFS path where CarbonData files will be kept. Strongly Recommended to put same as carbon.storelocation parameter of carbon.properties. If not specified then it takes spark.sql.warehouse.dir path.</td>
-<td><code>hdfs://<host_name>:port/user/hive/warehouse/carbon.store</code></td>
-</tr>
-</tbody>
-</table>
-<p><strong>NOTE</strong>: From Spark 1.6, by default the Thrift server runs in multi-session mode. Which means each JDBC/ODBC connection owns a copy of their own SQL configuration and temporary function registry. Cached tables are still shared though. If you prefer to run the Thrift server in single-session mode and share all SQL configuration and temporary function registry, please set option <code>spark.sql.hive.thriftServer.singleSession</code> to <code>true</code>. You may either add this option to <code>spark-defaults.conf</code>, or pass it to <code>spark-submit.sh</code> via <code>--conf</code>:</p>
-<pre><code>./bin/spark-submit
---conf spark.sql.hive.thriftServer.singleSession=true
---class org.apache.carbondata.spark.thriftserver.CarbonThriftServer
-$SPARK_HOME/carbonlib/$CARBON_ASSEMBLY_JAR <carbon_store_path>
-</code></pre>
-<p><strong>But</strong> in single-session mode, if one user changes the database from one connection, the database of the other connections will be changed too.</p>
-<p><strong>Examples</strong></p>
-<ul>
-<li>Start with default memory and executors.</li>
-</ul>
-<pre><code>./bin/spark-submit
---class org.apache.carbondata.spark.thriftserver.CarbonThriftServer
-$SPARK_HOME/carbonlib
-/carbondata_2.xx-x.x.x-SNAPSHOT-shade-hadoop2.7.2.jar
-hdfs://<host_name>:port/user/hive/warehouse/carbon.store
-</code></pre>
-<ul>
-<li>Start with Fixed executors and resources.</li>
-</ul>
-<pre><code>./bin/spark-submit
---class org.apache.carbondata.spark.thriftserver.CarbonThriftServer
---num-executors 3 --driver-memory 20g --executor-memory 250g
---executor-cores 32
-/srv/OSCON/BigData/HACluster/install/spark/sparkJdbc/lib
-/carbondata_2.xx-x.x.x-SNAPSHOT-shade-hadoop2.7.2.jar
-hdfs://<host_name>:port/user/hive/warehouse/carbon.store
-</code></pre>
-<h3>
-<a id="connecting-to-carbondata-thrift-server-using-beeline" class="anchor" href="#connecting-to-carbondata-thrift-server-using-beeline" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Connecting to CarbonData Thrift Server Using Beeline.</h3>
-<pre><code> cd $SPARK_HOME
- ./sbin/start-thriftserver.sh
- ./bin/beeline -u jdbc:hive2://<thriftserver_host>:port
-
- Example
- ./bin/beeline -u jdbc:hive2://10.10.10.10:10000
-</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/introduction.html
----------------------------------------------------------------------
diff --git a/content/introduction.html b/content/introduction.html
index 068d711..8f18870 100644
--- a/content/introduction.html
+++ b/content/introduction.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,17 +237,15 @@
</ul>
<h2>
<a id="carbondata-features--functions" class="anchor" href="#carbondata-features--functions" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>CarbonData Features & Functions</h2>
-<p>CarbonData has rich set of featues to support various use cases in Big Data analytics.The below table lists the major features supported by CarbonData.</p>
+<p>CarbonData has rich set of features to support various use cases in Big Data analytics. The below table lists the major features supported by CarbonData.</p>
<h3>
<a id="table-management" class="anchor" href="#table-management" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Table Management</h3>
<ul>
<li>
<h5>
<a id="ddl-create-alterdropctas" class="anchor" href="#ddl-create-alterdropctas" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>DDL (Create, Alter,Drop,CTAS)</h5>
+<p>CarbonData provides its own DDL to create and manage carbondata tables. These DDL conform to Hive,Spark SQL format and support additional properties and configuration to take advantages of CarbonData functionalities.</p>
</li>
-</ul>
-<p>? CarbonData provides its own DDL to create and manage carbondata tables.These DDL conform to Hive,Spark SQL format and support additional properties and configuration to take advantages of CarbonData functionalities.</p>
-<ul>
<li>
<h5>
<a id="dmlloadinsert" class="anchor" href="#dmlloadinsert" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>DML(Load,Insert)</h5>
@@ -263,7 +269,7 @@
<li>
<h5>
<a id="compaction" class="anchor" href="#compaction" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Compaction</h5>
-<p>CarbonData manages incremental loads as segments.Compaction help to compact the growing number of segments and also to improve query filter pruning.</p>
+<p>CarbonData manages incremental loads as segments. Compaction helps to compact the growing number of segments and also to improve query filter pruning.</p>
</li>
<li>
<h5>
@@ -277,12 +283,12 @@
<li>
<h5>
<a id="pre-aggregate" class="anchor" href="#pre-aggregate" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Pre-Aggregate</h5>
-<p>CarbonData has concept of datamaps to assist in pruning of data while querying so that performance is faster.Pre Aggregate tables are kind of datamaps which can improve the query performance by order of magnitude.CarbonData will automatically pre-aggregae the incremental data and re-write the query to automatically fetch from the most appropriate pre-aggregate table to serve the query faster.</p>
+<p>CarbonData has concept of datamaps to assist in pruning of data while querying so that performance is faster.Pre Aggregate tables are kind of datamaps which can improve the query performance by order of magnitude.CarbonData will automatically pre-aggregate the incremental data and re-write the query to automatically fetch from the most appropriate pre-aggregate table to serve the query faster.</p>
</li>
<li>
<h5>
<a id="time-series" class="anchor" href="#time-series" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Time Series</h5>
-<p>CarbonData has built in understanding of time order(Year, month,day,hour, minute,second).Time series is a pre-aggregate table which can automatically roll-up the data to the desired level during incremental load and serve the query from the most appropriate pre-aggregate table.</p>
+<p>CarbonData has built in understanding of time order(Year, month,day,hour, minute,second). Time series is a pre-aggregate table which can automatically roll-up the data to the desired level during incremental load and serve the query from the most appropriate pre-aggregate table.</p>
</li>
<li>
<h5>
@@ -297,7 +303,7 @@
<li>
<h5>
<a id="mv-materialized-views" class="anchor" href="#mv-materialized-views" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>MV (Materialized Views)</h5>
-<p>MVs are kind of pre-aggregate tables which can support efficent query re-write and processing.CarbonData provides MV which can rewrite query to fetch from any table(including non-carbondata tables).Typical usecase is to store the aggregated data of a non-carbondata fact table into carbondata and use mv to rewrite the query to fetch from carbondata.</p>
+<p>MVs are kind of pre-aggregate tables which can support efficent query re-write and processing.CarbonData provides MV which can rewrite query to fetch from any table(including non-carbondata tables). Typical usecase is to store the aggregated data of a non-carbondata fact table into carbondata and use mv to rewrite the query to fetch from carbondata.</p>
</li>
</ul>
<h3>
@@ -315,12 +321,12 @@
<li>
<h5>
<a id="carbondata-writer" class="anchor" href="#carbondata-writer" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>CarbonData writer</h5>
-<p>CarbonData supports writing data from non-spark application using SDK.Users can use SDK to generate carbondata files from custom applications.Typical usecase is to write the streaming application plugged in to kafka and use carbondata as sink(target) table for storing.</p>
+<p>CarbonData supports writing data from non-spark application using SDK.Users can use SDK to generate carbondata files from custom applications. Typical usecase is to write the streaming application plugged in to kafka and use carbondata as sink(target) table for storing.</p>
</li>
<li>
<h5>
<a id="carbondata-reader" class="anchor" href="#carbondata-reader" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>CarbonData reader</h5>
-<p>CarbonData supports reading of data from non-spark application using SDK.Users can use the SDK to read the carbondata files from their application and do custom processing.</p>
+<p>CarbonData supports reading of data from non-spark application using SDK. Users can use the SDK to read the carbondata files from their application and do custom processing.</p>
</li>
</ul>
<h3>
@@ -329,7 +335,7 @@
<li>
<h5>
<a id="s3" class="anchor" href="#s3" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>S3</h5>
-<p>CarbonData can write to S3, OBS or any cloud storage confirming to S3 protocol.CarbonData uses the HDFS api to write to cloud object stores.</p>
+<p>CarbonData can write to S3, OBS or any cloud storage confirming to S3 protocol. CarbonData uses the HDFS api to write to cloud object stores.</p>
</li>
<li>
<h5>
http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6ad7599a/content/language-manual.html
----------------------------------------------------------------------
diff --git a/content/language-manual.html b/content/language-manual.html
index a0ea674..74c18f4 100644
--- a/content/language-manual.html
+++ b/content/language-manual.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>
@@ -236,11 +244,12 @@
<li>Data Manipulation Statements
<ul>
<li>
-<a href="./dml-of-carbondata.html">DML:</a> <a href="./dml-of-carbondata.html#load-data">Load</a>, <a href="./ddl-of-carbondata.html#insert-overwrite">Insert</a>, <a href="./dml-of-carbondata.html#update">Update</a>, <a href="./dml-of-carbondata.html#delete">Delete</a>
+<a href="./dml-of-carbondata.html">DML:</a> <a href="./dml-of-carbondata.html#load-data">Load</a>, <a href="./dml-of-carbondata.html#insert-data-into-carbondata-table">Insert</a>, <a href="./dml-of-carbondata.html#update">Update</a>, <a href="./dml-of-carbondata.html#delete">Delete</a>
</li>
<li><a href="./segment-management-on-carbondata.html">Segment Management</a></li>
</ul>
</li>
+<li><a href="./carbon-as-spark-datasource-guide.html">CarbonData as Spark's Datasource</a></li>
<li><a href="./configuration-parameters.html">Configuration Properties</a></li>
</ul>
<script>
http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6ad7599a/content/lucene-datamap-guide.html
----------------------------------------------------------------------
diff --git a/content/lucene-datamap-guide.html b/content/lucene-datamap-guide.html
index b8164a2..357286a 100644
--- a/content/lucene-datamap-guide.html
+++ b/content/lucene-datamap-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>
@@ -239,7 +247,7 @@ ON TABLE main_table
<h2>
<a id="lucene-datamap-introduction" class="anchor" href="#lucene-datamap-introduction" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Lucene DataMap Introduction</h2>
<p>Lucene is a high performance, full featured text search engine. Lucene is integrated to carbon as
-an index datamap and managed along with main tables by CarbonData.User can create lucene datamap
+an index datamap and managed along with main tables by CarbonData. User can create lucene datamap
to improve query performance on string columns which has content of more length. So, user can
search tokenized word or pattern of it using lucene query on text content.</p>
<p>For instance, main table called <strong>datamap_test</strong> which is defined as:</p>
@@ -281,7 +289,7 @@ value is compression, the index file size will be compressed.</p>
Queries are to be made on main table. when a query with TEXT_MATCH('name:c10') or
TEXT_MATCH_WITH_LIMIT('name:n10',10)[the second parameter represents the number of result to be
returned, if user does not specify this value, all results will be returned without any limit] is
-fired, two jobs are fired.The first job writes the temporary files in folder created at table level
+fired, two jobs are fired. The first job writes the temporary files in folder created at table level
which contains lucene's seach results and these files will be read in second job to give faster
results. These temporary files will be cleared once the query finishes.</p>
<p>User can verify whether a query can leverage Lucene datamap or not by executing <code>EXPLAIN</code>
http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6ad7599a/content/mainpage.html
----------------------------------------------------------------------
diff --git a/content/mainpage.html b/content/mainpage.html
deleted file mode 100644
index d515853..0000000
--- a/content/mainpage.html
+++ /dev/null
@@ -1,214 +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.4.1/"
- target="_blank">Apache CarbonData 1.4.1</a></li>
- <li>
- <a href="https://dist.apache.org/repos/dist/release/carbondata/1.4.0/"
- target="_blank">Apache CarbonData 1.4.0</a></li>
- <li>
- <a href="https://dist.apache.org/repos/dist/release/carbondata/1.3.1/"
- target="_blank">Apache CarbonData 1.3.1</a></li>
- <li>
- <a href="https://dist.apache.org/repos/dist/release/carbondata/1.3.0/"
- target="_blank">Apache CarbonData 1.3.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">
- <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="doc-heading">
- <h4 class="title">Documentation
- <span class="title-underline"></span>
- </h4>
- </div>
-
- <div class="row">
-
- <div class="col-sm-12 col-md-12">
- <span class="text-justify">
- Welcome to Apache CarbonData. 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. This user guide provides a detailed description about the CarbonData and its features.
- Let's get started !
- </span>
- <hr style="margin: 12px 0 8px">
- <div>
- <ul class="sub-nav">
- <li><a href="quick-start-guide.html">Quick Start</a></li>
- <li><a href="file-structure-of-carbondata.html">CarbonData File Structure</a></li>
- <li><a href="supported-data-types-in-carbondata.html">Data Types</a></li>
- <li><a href="data-management-on-carbondata.html">Data Management On CarbonData</a></li>
- <li><a href="installation-guide.html">Installation Guide</a></li>
- <li><a href="configuration-parameters.html">Configuring CarbonData</a></li>
- <li><a href="streaming-guide.html">Streaming Guide</a></li>
- <li><a href="sdk-guide.html">SDK Guide</a></li>
- <li><a href="s3-guide.html">S3 Guide (Alpha Feature)</a></li>
- <li><a href="datamap-developer-guide.html">DataMap Developer Guide</a></li>
- <li><a href="datamap-management.html">CarbonData DataMap Management</a></li>
- <li><a href="bloomfilter-datamap-guide.html">CarbonData BloomFilter DataMap (Alpha Feature)</a></li>
- <li><a href="lucene-datamap-guide.html">CarbonData Lucene DataMap (Alpha Feature)</a></li>
- <li><a href="preaggregate-datamap-guide.html">CarbonData Pre-aggregate DataMap</a></li>
- <li><a href="timeseries-datamap-guide.html">CarbonData Timeseries DataMap</a></li>
- <li><a href="faq.html">FAQs</a></li>
- <li><a href="troubleshooting.html">Troubleshooting</a></li>
- <li><a href="useful-tips-on-carbondata.html">Useful Tips</a></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 -->
-</div>
-</div>
-</div>
-</section><!-- End systemblock part -->
-<script src="js/custom.js"></script>
-</body>
-</html>
http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6ad7599a/content/performance-tuning.html
----------------------------------------------------------------------
diff --git a/content/performance-tuning.html b/content/performance-tuning.html
index 480911c..c63462f 100644
--- a/content/performance-tuning.html
+++ b/content/performance-tuning.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>
@@ -381,7 +389,7 @@ You can configure CarbonData by tuning following properties in carbon.properties
<tbody>
<tr>
<td>carbon.number.of.cores.while.loading</td>
-<td>Default: 2.This value should be >= 2</td>
+<td>Default: 2. This value should be >= 2</td>
<td>Specifies the number of cores used for data processing during data loading in CarbonData.</td>
</tr>
<tr>
@@ -447,7 +455,7 @@ scenarios. After the completion of POC, some of the configurations impacting the
<td>spark/carbonlib/carbon.properties</td>
<td>Data loading and Querying</td>
<td>For minor compaction, specifies the number of segments to be merged in stage 1 and number of compacted segments to be merged in stage 2.</td>
-<td>Each CarbonData load will create one segment, if every load is small in size it will generate many small file over a period of time impacting the query performance. Configuring this parameter will merge the small segment to one big segment which will sort the data and improve the performance. For Example in one telecommunication scenario, the performance improves about 2 times after minor compaction.</td>
+<td>Each CarbonData load will create one segment, if every load is small in size it will generate many small files over a period of time impacting the query performance. Configuring this parameter will merge the small segment to one big segment which will sort the data and improve the performance. For Example in one telecommunication scenario, the performance improves about 2 times after minor compaction.</td>
</tr>
<tr>
<td>spark.sql.shuffle.partitions</td>
@@ -489,21 +497,21 @@ scenarios. After the completion of POC, some of the configurations impacting the
<td>spark/carbonlib/carbon.properties</td>
<td>Data loading</td>
<td>Specify the name of compressor to compress the intermediate sort temporary files during sort procedure in data loading.</td>
-<td>The optional values are 'SNAPPY','GZIP','BZIP2','LZ4','ZSTD' and empty. By default, empty means that Carbondata will not compress the sort temp files. This parameter will be useful if you encounter disk bottleneck.</td>
+<td>The optional values are 'SNAPPY','GZIP','BZIP2','LZ4','ZSTD', and empty. By default, empty means that Carbondata will not compress the sort temp files. This parameter will be useful if you encounter disk bottleneck.</td>
</tr>
<tr>
<td>carbon.load.skewedDataOptimization.enabled</td>
<td>spark/carbonlib/carbon.properties</td>
<td>Data loading</td>
<td>Whether to enable size based block allocation strategy for data loading.</td>
-<td>When loading, carbondata will use file size based block allocation strategy for task distribution. It will make sure that all the executors process the same size of data -- It's useful if the size of your input data files varies widely, say 1MB~1GB.</td>
+<td>When loading, carbondata will use file size based block allocation strategy for task distribution. It will make sure that all the executors process the same size of data -- It's useful if the size of your input data files varies widely, say 1MB to 1GB.</td>
</tr>
<tr>
<td>carbon.load.min.size.enabled</td>
<td>spark/carbonlib/carbon.properties</td>
<td>Data loading</td>
<td>Whether to enable node minumun input data size allocation strategy for data loading.</td>
-<td>When loading, carbondata will use node minumun input data size allocation strategy for task distribution. It will make sure the node load the minimum amount of data -- It's useful if the size of your input data files very small, say 1MB~256MB,Avoid generating a large number of small files.</td>
+<td>When loading, carbondata will use node minumun input data size allocation strategy for task distribution. It will make sure the nodes load the minimum amount of data -- It's useful if the size of your input data files very small, say 1MB to 256MB,Avoid generating a large number of small files.</td>
</tr>
</tbody>
</table>
http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6ad7599a/content/preaggregate-datamap-guide.html
----------------------------------------------------------------------
diff --git a/content/preaggregate-datamap-guide.html b/content/preaggregate-datamap-guide.html
index 6b0783e..c3d4a85 100644
--- a/content/preaggregate-datamap-guide.html
+++ b/content/preaggregate-datamap-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>
@@ -444,7 +452,7 @@ pre-aggregate tables. To further improve the query performance, compaction on pr
can be triggered to merge the segments and files in the pre-aggregate tables.</p>
<h2>
<a id="data-management-with-pre-aggregate-tables" class="anchor" href="#data-management-with-pre-aggregate-tables" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Data Management with pre-aggregate tables</h2>
-<p>In current implementation, data consistence need to be maintained for both main table and pre-aggregate
+<p>In current implementation, data consistency needs to be maintained for both main table and pre-aggregate
tables. Once there is pre-aggregate table created on the main table, following command on the main
table
is not supported:</p>
http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6ad7599a/content/quick-start-guide.html
----------------------------------------------------------------------
diff --git a/content/quick-start-guide.html b/content/quick-start-guide.html
index f3e8a8f..8e599d3 100644
--- a/content/quick-start-guide.html
+++ b/content/quick-start-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>
@@ -212,7 +220,7 @@
<div>
<h1>
<a id="quick-start" class="anchor" href="#quick-start" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Quick Start</h1>
-<p>This tutorial provides a quick introduction to using CarbonData.To follow along with this guide, first download a packaged release of CarbonData from the <a href="https://dist.apache.org/repos/dist/release/carbondata/" target=_blank rel="nofollow">CarbonData website</a>.Alternatively it can be created following <a href="https://github.com/apache/carbondata/tree/master/build" target=_blank>Building CarbonData</a> steps.</p>
+<p>This tutorial provides a quick introduction to using CarbonData. To follow along with this guide, first download a packaged release of CarbonData from the <a href="https://dist.apache.org/repos/dist/release/carbondata/" target=_blank rel="nofollow">CarbonData website</a>.Alternatively it can be created following <a href="https://github.com/apache/carbondata/tree/master/build" target=_blank>Building CarbonData</a> steps.</p>
<h2>
<a id="prerequisites" class="anchor" href="#prerequisites" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Prerequisites</h2>
<ul>
@@ -233,7 +241,7 @@ EOF
</ul>
<h2>
<a id="integration" class="anchor" href="#integration" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Integration</h2>
-<p>CarbonData can be integrated with Spark and Presto Execution Engines.The below documentation guides on Installing and Configuring with these execution engines.</p>
+<p>CarbonData can be integrated with Spark and Presto Execution Engines. The below documentation guides on Installing and Configuring with these execution engines.</p>
<h3>
<a id="spark" class="anchor" href="#spark" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Spark</h3>
<p><a href="#installing-and-configuring-carbondata-to-run-locally-with-spark-shell">Installing and Configuring CarbonData to run locally with Spark Shell</a></p>
@@ -555,26 +563,26 @@ hdfs://<host_name>:port/user/hive/warehouse/carbon.store
</code></pre>
<h2>
<a id="installing-and-configuring-carbondata-on-presto" class="anchor" href="#installing-and-configuring-carbondata-on-presto" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Installing and Configuring CarbonData on Presto</h2>
-<p><strong>NOTE:</strong> <strong>CarbonData tables cannot be created nor loaded from Presto.User need to create CarbonData Table and load data into it
+<p><strong>NOTE:</strong> <strong>CarbonData tables cannot be created nor loaded from Presto. User need to create CarbonData Table and load data into it
either with <a href="#installing-and-configuring-carbondata-to-run-locally-with-spark-shell">Spark</a> or <a href="./sdk-guide.html">SDK</a>.
Once the table is created,it can be queried from Presto.</strong></p>
<h3>
<a id="installing-presto" class="anchor" href="#installing-presto" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Installing Presto</h3>
<ol>
<li>
-<p>Download the 0.187 version of Presto using:
-<code>wget https://repo1.maven.org/maven2/com/facebook/presto/presto-server/0.187/presto-server-0.187.tar.gz</code></p>
+<p>Download the 0.210 version of Presto using:
+<code>wget https://repo1.maven.org/maven2/com/facebook/presto/presto-server/0.210/presto-server-0.210.tar.gz</code></p>
</li>
<li>
-<p>Extract Presto tar file: <code>tar zxvf presto-server-0.187.tar.gz</code>.</p>
+<p>Extract Presto tar file: <code>tar zxvf presto-server-0.210.tar.gz</code>.</p>
</li>
<li>
<p>Download the Presto CLI for the coordinator and name it presto.</p>
</li>
</ol>
-<pre><code> wget https://repo1.maven.org/maven2/com/facebook/presto/presto-cli/0.187/presto-cli-0.187-executable.jar
+<pre><code> wget https://repo1.maven.org/maven2/com/facebook/presto/presto-cli/0.210/presto-cli-0.210-executable.jar
- mv presto-cli-0.187-executable.jar presto
+ mv presto-cli-0.210-executable.jar presto
chmod +x presto
</code></pre>
@@ -582,7 +590,7 @@ Once the table is created,it can be queried from Presto.</strong></p>
<a id="create-configuration-files" class="anchor" href="#create-configuration-files" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Create Configuration Files</h3>
<ol>
<li>
-<p>Create <code>etc</code> folder in presto-server-0.187 directory.</p>
+<p>Create <code>etc</code> folder in presto-server-0.210 directory.</p>
</li>
<li>
<p>Create <code>config.properties</code>, <code>jvm.config</code>, <code>log.properties</code>, and <code>node.properties</code> files.</p>
@@ -624,10 +632,15 @@ node.data-dir=/home/ubuntu/data
<pre><code>coordinator=true
node-scheduler.include-coordinator=false
http-server.http.port=8086
-query.max-memory=50GB
-query.max-memory-per-node=2GB
+query.max-memory=5GB
+query.max-total-memory-per-node=5GB
+query.max-memory-per-node=3GB
+memory.heap-headroom-per-node=1GB
discovery-server.enabled=true
-discovery.uri=<coordinator_ip>:8086
+discovery.uri=http://localhost:8086
+task.max-worker-threads=4
+optimizer.dictionary-aggregation=true
+optimizer.optimize-hash-generation = false
</code></pre>
<p>The options <code>node-scheduler.include-coordinator=false</code> and <code>coordinator=true</code> indicate that the node is the coordinator and tells the coordinator not to do any of the computation work itself and to use the workers.</p>
<p><strong>Note</strong>: It is recommended to set <code>query.max-memory-per-node</code> to half of the JVM config max memory, though the workload is highly concurrent, lower value for <code>query.max-memory-per-node</code> is to be used.</p>
@@ -640,7 +653,7 @@ Then, <code>query.max-memory=<30GB * number of nodes></code>.</p>
<a id="contents-of-your-configproperties-1" class="anchor" href="#contents-of-your-configproperties-1" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Contents of your config.properties</h5>
<pre><code>coordinator=false
http-server.http.port=8086
-query.max-memory=50GB
+query.max-memory=5GB
query.max-memory-per-node=2GB
discovery.uri=<coordinator_ip>:8086
</code></pre>
@@ -663,10 +676,10 @@ discovery.uri=<coordinator_ip>:8086
</ol>
<h3>
<a id="start-presto-server-on-all-nodes" class="anchor" href="#start-presto-server-on-all-nodes" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Start Presto Server on all nodes</h3>
-<pre><code>./presto-server-0.187/bin/launcher start
+<pre><code>./presto-server-0.210/bin/launcher start
</code></pre>
<p>To run it as a background process.</p>
-<pre><code>./presto-server-0.187/bin/launcher run
+<pre><code>./presto-server-0.210/bin/launcher run
</code></pre>
<p>To run it in foreground.</p>
<h3>
http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6ad7599a/content/release-guide.html
----------------------------------------------------------------------
diff --git a/content/release-guide.html b/content/release-guide.html
index cb47540..891d897 100644
--- a/content/release-guide.html
+++ b/content/release-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>
http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6ad7599a/content/s3-guide.html
----------------------------------------------------------------------
diff --git a/content/s3-guide.html b/content/s3-guide.html
index 57af913..62c51c3 100644
--- a/content/s3-guide.html
+++ b/content/s3-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>
@@ -211,7 +219,7 @@
<div class="col-sm-12 col-md-12">
<div>
<h1>
-<a id="s3-guide-alpha-feature-141" class="anchor" href="#s3-guide-alpha-feature-141" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>S3 Guide (Alpha Feature 1.4.1)</h1>
+<a id="s3-guide" class="anchor" href="#s3-guide" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>S3 Guide</h1>
<p>Object storage is the recommended storage format in cloud as it can support storing large data
files. S3 APIs are widely used for accessing object stores. This can be
used to store or retrieve data on Amazon cloud, Huawei Cloud(OBS) or on any other object
[02/20] carbondata-site git commit: modified for 1.5.0 version
Posted by ch...@apache.org.
http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6ad7599a/src/site/markdown/datamap-developer-guide.md
----------------------------------------------------------------------
diff --git a/src/site/markdown/datamap-developer-guide.md b/src/site/markdown/datamap-developer-guide.md
index 6bac9b5..60f93df 100644
--- a/src/site/markdown/datamap-developer-guide.md
+++ b/src/site/markdown/datamap-developer-guide.md
@@ -6,7 +6,7 @@ Currently, there are two 2 types of DataMap supported:
1. IndexDataMap: DataMap that leverages index to accelerate filter query
2. MVDataMap: DataMap that leverages Materialized View to accelerate olap style query, like SPJG query (select, predicate, join, groupby)
-### DataMap provider
+### DataMap Provider
When user issues `CREATE DATAMAP dm ON TABLE main USING 'provider'`, the corresponding DataMapProvider implementation will be created and initialized.
Currently, the provider string can be:
1. preaggregate: A type of MVDataMap that do pre-aggregate of single table
@@ -15,5 +15,5 @@ Currently, the provider string can be:
When user issues `DROP DATAMAP dm ON TABLE main`, the corresponding DataMapProvider interface will be called.
-Details about [DataMap Management](./datamap/datamap-management.md#datamap-management) and supported [DSL](./datamap/datamap-management.md#overview) are documented [here](./datamap/datamap-management.md).
+Click for more details about [DataMap Management](./datamap/datamap-management.md#datamap-management) and supported [DSL](./datamap/datamap-management.md#overview).
http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6ad7599a/src/site/markdown/datamap-management.md
----------------------------------------------------------------------
diff --git a/src/site/markdown/datamap-management.md b/src/site/markdown/datamap-management.md
index eee03a7..ad8718a 100644
--- a/src/site/markdown/datamap-management.md
+++ b/src/site/markdown/datamap-management.md
@@ -66,9 +66,9 @@ If user create MV datamap without specifying `WITH DEFERRED REBUILD`, carbondata
### Automatic Refresh
When user creates a datamap on the main table without using `WITH DEFERRED REBUILD` 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.
+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.
-The data loading to datamap is incremental based on Segment concept, avoiding a expesive total rebuild.
+The data loading to datamap is incremental based on Segment concept, avoiding a expensive total rebuild.
If user perform following command on the main table, system will return failure. (reject the operation)
@@ -87,7 +87,7 @@ We do recommend you to use this management for index datamap.
### Manual Refresh
-When user creates a datamap specifying maunal refresh semantic, the datamap is created with status *disabled* 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 *enabled*, so that it can be used in query rewrite.
+When user creates a datamap specifying manual refresh semantic, the datamap is created with status *disabled* 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 *enabled*, so that it can be used in query rewrite.
For every new data loading, data update, delete, the related datamap will be made *disabled*,
which means that the following queries will not benefit from the datamap before it becomes *enabled* again.
@@ -122,7 +122,7 @@ There is a DataMapCatalog interface to retrieve schema of all datamap, it can be
How can user know whether datamap is used in the query?
-User can use EXPLAIN command to know, it will print out something like
+User can set enable.query.statistics = true and use EXPLAIN command to know, it will print out something like
```text
== CarbonData Profiler ==
http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6ad7599a/src/site/markdown/ddl-of-carbondata.md
----------------------------------------------------------------------
diff --git a/src/site/markdown/ddl-of-carbondata.md b/src/site/markdown/ddl-of-carbondata.md
index acaac43..933a448 100644
--- a/src/site/markdown/ddl-of-carbondata.md
+++ b/src/site/markdown/ddl-of-carbondata.md
@@ -32,6 +32,8 @@ CarbonData DDL statements are documented here,which includes:
* [Caching Level](#caching-at-block-or-blocklet-level)
* [Hive/Parquet folder Structure](#support-flat-folder-same-as-hiveparquet)
* [Extra Long String columns](#string-longer-than-32000-characters)
+ * [Compression for Table](#compression-for-table)
+ * [Bad Records Path](#bad-records-path)
* [CREATE TABLE AS SELECT](#create-table-as-select)
* [CREATE EXTERNAL TABLE](#create-external-table)
* [External Table on Transactional table location](#create-external-table-on-managed-table-data-location)
@@ -72,6 +74,7 @@ CarbonData DDL statements are documented here,which includes:
[TBLPROPERTIES (property_name=property_value, ...)]
[LOCATION 'path']
```
+
**NOTE:** CarbonData also supports "STORED AS carbondata" and "USING carbondata". Find example code at [CarbonSessionExample](https://github.com/apache/carbondata/blob/master/examples/spark2/src/main/scala/org/apache/carbondata/examples/CarbonSessionExample.scala) in the CarbonData repo.
### Usage Guidelines
@@ -84,19 +87,20 @@ CarbonData DDL statements are documented here,which includes:
| [SORT_COLUMNS](#sort-columns-configuration) | Columns to include in sort and its order of sort |
| [SORT_SCOPE](#sort-scope-configuration) | Sort scope of the load.Options include no sort, local sort ,batch sort and global sort |
| [TABLE_BLOCKSIZE](#table-block-size-configuration) | Size of blocks to write onto hdfs |
+| [TABLE_BLOCKLET_SIZE](#table-blocklet-size-configuration) | Size of blocklet to write in the file |
| [MAJOR_COMPACTION_SIZE](#table-compaction-configuration) | Size upto which the segments can be combined into one |
| [AUTO_LOAD_MERGE](#table-compaction-configuration) | Whether to auto compact the segments |
| [COMPACTION_LEVEL_THRESHOLD](#table-compaction-configuration) | Number of segments to compact into one segment |
| [COMPACTION_PRESERVE_SEGMENTS](#table-compaction-configuration) | Number of latest segments that needs to be excluded from compaction |
| [ALLOWED_COMPACTION_DAYS](#table-compaction-configuration) | Segments generated within the configured time limit in days will be compacted, skipping others |
-| [streaming](#streaming) | Whether the table is a streaming table |
+| [STREAMING](#streaming) | Whether the table is a streaming table |
| [LOCAL_DICTIONARY_ENABLE](#local-dictionary-configuration) | Enable local dictionary generation |
| [LOCAL_DICTIONARY_THRESHOLD](#local-dictionary-configuration) | Cardinality upto which the local dictionary can be generated |
-| [LOCAL_DICTIONARY_INCLUDE](#local-dictionary-configuration) | Columns for which local dictionary needs to be generated.Useful when local dictionary need not be generated for all string/varchar/char columns |
-| [LOCAL_DICTIONARY_EXCLUDE](#local-dictionary-configuration) | Columns for which local dictionary generation should be skipped.Useful when local dictionary need not be generated for few string/varchar/char columns |
+| [LOCAL_DICTIONARY_INCLUDE](#local-dictionary-configuration) | Columns for which local dictionary needs to be generated. Useful when local dictionary need not be generated for all string/varchar/char columns |
+| [LOCAL_DICTIONARY_EXCLUDE](#local-dictionary-configuration) | Columns for which local dictionary generation should be skipped. Useful when local dictionary need not be generated for few string/varchar/char columns |
| [COLUMN_META_CACHE](#caching-minmax-value-for-required-columns) | Columns whose metadata can be cached in Driver for efficient pruning and improved query performance |
-| [CACHE_LEVEL](#caching-at-block-or-blocklet-level) | Column metadata caching level.Whether to cache column metadata of block or blocklet |
-| [flat_folder](#support-flat-folder-same-as-hiveparquet) | Whether to write all the carbondata files in a single folder.Not writing segments folder during incremental load |
+| [CACHE_LEVEL](#caching-at-block-or-blocklet-level) | Column metadata caching level. Whether to cache column metadata of block or blocklet |
+| [FLAT_FOLDER](#support-flat-folder-same-as-hiveparquet) | Whether to write all the carbondata files in a single folder.Not writing segments folder during incremental load |
| [LONG_STRING_COLUMNS](#string-longer-than-32000-characters) | Columns which are greater than 32K characters |
| [BUCKETNUMBER](#bucketing) | Number of buckets to be created |
| [BUCKETCOLUMNS](#bucketing) | Columns which are to be placed in buckets |
@@ -110,9 +114,10 @@ CarbonData DDL statements are documented here,which includes:
```
TBLPROPERTIES ('DICTIONARY_INCLUDE'='column1, column2')
- ```
- NOTE: Dictionary Include/Exclude for complex child columns is not supported.
-
+ ```
+
+ **NOTE**: Dictionary Include/Exclude for complex child columns is not supported.
+
- ##### Inverted Index Configuration
By default inverted index is enabled, it might help to improve compression ratio and query speed, especially for low cardinality columns which are in reward position.
@@ -127,7 +132,7 @@ CarbonData DDL statements are documented here,which includes:
This property is for users to specify which columns belong to the MDK(Multi-Dimensions-Key) index.
* If users don't specify "SORT_COLUMN" property, by default MDK index be built by using all dimension columns except complex data type column.
* If this property is specified but with empty argument, then the table will be loaded without sort.
- * This supports only string, date, timestamp, short, int, long, and boolean data types.
+ * 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.
```
@@ -135,7 +140,8 @@ CarbonData DDL statements are documented here,which includes:
OR
TBLPROPERTIES ('SORT_COLUMNS'='')
```
- NOTE: Sort_Columns for Complex datatype columns is not supported.
+
+ **NOTE**: Sort_Columns for Complex datatype columns is not supported.
- ##### Sort Scope Configuration
@@ -146,10 +152,10 @@ CarbonData DDL statements are documented here,which includes:
* BATCH_SORT: It increases the load performance but decreases the query performance if identified blocks > parallelism.
* GLOBAL_SORT: It increases the query performance, especially high concurrent point query.
And if you care about loading resources isolation strictly, because the system uses the spark GroupBy to sort data, the resource can be controlled by spark.
-
- ### Example:
- ```
+ ### Example:
+
+ ```
CREATE TABLE IF NOT EXISTS productSchema.productSalesTable (
productNumber INT,
productName STRING,
@@ -162,19 +168,30 @@ CarbonData DDL statements are documented here,which includes:
STORED AS carbondata
TBLPROPERTIES ('SORT_COLUMNS'='productName,storeCity',
'SORT_SCOPE'='NO_SORT')
- ```
+ ```
**NOTE:** CarbonData also supports "using carbondata". Find example code at [SparkSessionExample](https://github.com/apache/carbondata/blob/master/examples/spark2/src/main/scala/org/apache/carbondata/examples/SparkSessionExample.scala) in the CarbonData repo.
- ##### Table Block Size Configuration
- 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.
+ 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.
```
TBLPROPERTIES ('TABLE_BLOCKSIZE'='512')
```
+
**NOTE:** 512 or 512M both are accepted.
+ - ##### Table Blocklet Size Configuration
+
+ 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.
+
+ Example usage:
+ ```
+ TBLPROPERTIES ('TABLE_BLOCKLET_SIZE'='8')
+ ```
+
- ##### Table Compaction Configuration
These properties are table level compaction configurations, if not specified, system level configurations in carbon.properties will be used.
@@ -196,7 +213,7 @@ CarbonData DDL statements are documented here,which includes:
- ##### Streaming
- CarbonData supports streaming ingestion for real-time data. You can create the ‘streaming’ table using the following table properties.
+ CarbonData supports streaming ingestion for real-time data. You can create the 'streaming' table using the following table properties.
```
TBLPROPERTIES ('streaming'='true')
@@ -231,7 +248,13 @@ CarbonData DDL statements are documented here,which includes:
* In case of multi-level complex dataType columns, primitive string/varchar/char columns are considered for local dictionary generation.
- Local dictionary will have to be enabled explicitly during create table or by enabling the **system property** ***carbon.local.dictionary.enable***. By default, Local Dictionary will be disabled for the carbondata table.
+ System Level Properties for Local Dictionary:
+
+
+ | Properties | Default value | Description |
+ | ---------- | ------------- | ----------- |
+ | carbon.local.dictionary.enable | false | By default, Local Dictionary will be disabled for the carbondata table. |
+ | carbon.local.dictionary.decoder.fallback | true | 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. **NOTE:** Memory footprint decreases significantly as compared to when this property is set to false |
Local Dictionary can be configured using the following properties during create table command:
@@ -239,24 +262,24 @@ CarbonData DDL statements are documented here,which includes:
| Properties | Default value | Description |
| ---------- | ------------- | ----------- |
| LOCAL_DICTIONARY_ENABLE | false | Whether to enable local dictionary generation. **NOTE:** If this property is defined, it will override the value configured at system level by '***carbon.local.dictionary.enable***'.Local dictionary will be generated for all string/varchar/char columns unless LOCAL_DICTIONARY_INCLUDE, LOCAL_DICTIONARY_EXCLUDE is configured. |
-| LOCAL_DICTIONARY_THRESHOLD | 10000 | The maximum cardinality of a column upto which carbondata can try to generate local dictionary (maximum - 100000) |
-| LOCAL_DICTIONARY_INCLUDE | string/varchar/char columns| Columns for which Local Dictionary has to be generated.**NOTE:** 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 **LOCAL_DICTIONARY_ENABLE** is true or **carbon.local.dictionary.enable** is true |
-| LOCAL_DICTIONARY_EXCLUDE | none | 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 **LOCAL_DICTIONARY_ENABLE** is true or **carbon.local.dictionary.enable** is true |
+| LOCAL_DICTIONARY_THRESHOLD | 10000 | The maximum cardinality of a column upto which carbondata can try to generate local dictionary (maximum - 100000). **NOTE:** When LOCAL_DICTIONARY_THRESHOLD is defined for Complex columns, the count of distinct records of all child columns are summed up. |
+| LOCAL_DICTIONARY_INCLUDE | string/varchar/char columns| Columns for which Local Dictionary has to be generated.**NOTE:** 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 **LOCAL_DICTIONARY_ENABLE** is true or **carbon.local.dictionary.enable** is true |
+| LOCAL_DICTIONARY_EXCLUDE | none | 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 **LOCAL_DICTIONARY_ENABLE** is true or **carbon.local.dictionary.enable** is true |
**Fallback behavior:**
* 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.
+
+ * 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.
**NOTE:** 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.
**Points to be noted:**
- 1. Reduce Block size:
+ * Reduce Block size:
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.
- 2. 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.
-
### Example:
```
@@ -287,19 +310,19 @@ CarbonData DDL statements are documented here,which includes:
* If you want no column min/max values to be cached in the driver.
```
- COLUMN_META_CACHE=’’
+ COLUMN_META_CACHE=''
```
* If you want only col1 min/max values to be cached in the driver.
```
- COLUMN_META_CACHE=’col1’
+ COLUMN_META_CACHE='col1'
```
* If you want min/max values to be cached in driver for all the specified columns.
```
- COLUMN_META_CACHE=’col1,col2,col3,…’
+ COLUMN_META_CACHE='col1,col2,col3,…'
```
Columns to be cached can be specified either while creating table or after creation of the table.
@@ -308,13 +331,13 @@ CarbonData DDL statements are documented here,which includes:
Syntax:
```
- CREATE TABLE [dbName].tableName (col1 String, col2 String, col3 int,…) STORED BY ‘carbondata’ TBLPROPERTIES (‘COLUMN_META_CACHE’=’col1,col2,…’)
+ CREATE TABLE [dbName].tableName (col1 String, col2 String, col3 int,…) STORED BY 'carbondata' TBLPROPERTIES ('COLUMN_META_CACHE'='col1,col2,…')
```
Example:
```
- CREATE TABLE employee (name String, city String, id int) STORED BY ‘carbondata’ TBLPROPERTIES (‘COLUMN_META_CACHE’=’name’)
+ CREATE TABLE employee (name String, city String, id int) STORED BY 'carbondata' TBLPROPERTIES ('COLUMN_META_CACHE'='name')
```
After creation of table or on already created tables use the alter table command to configure the columns to be cached.
@@ -322,13 +345,13 @@ CarbonData DDL statements are documented here,which includes:
Syntax:
```
- ALTER TABLE [dbName].tableName SET TBLPROPERTIES (‘COLUMN_META_CACHE’=’col1,col2,…’)
+ ALTER TABLE [dbName].tableName SET TBLPROPERTIES ('COLUMN_META_CACHE'='col1,col2,…')
```
Example:
```
- ALTER TABLE employee SET TBLPROPERTIES (‘COLUMN_META_CACHE’=’city’)
+ ALTER TABLE employee SET TBLPROPERTIES ('COLUMN_META_CACHE'='city')
```
- ##### Caching at Block or Blocklet Level
@@ -340,13 +363,13 @@ CarbonData DDL statements are documented here,which includes:
*Configuration for caching in driver at Block level (default value).*
```
- CACHE_LEVEL= ‘BLOCK’
+ CACHE_LEVEL= 'BLOCK'
```
*Configuration for caching in driver at Blocklet level.*
```
- CACHE_LEVEL= ‘BLOCKLET’
+ CACHE_LEVEL= 'BLOCKLET'
```
Cache level can be specified either while creating table or after creation of the table.
@@ -355,13 +378,13 @@ CarbonData DDL statements are documented here,which includes:
Syntax:
```
- CREATE TABLE [dbName].tableName (col1 String, col2 String, col3 int,…) STORED BY ‘carbondata’ TBLPROPERTIES (‘CACHE_LEVEL’=’Blocklet’)
+ CREATE TABLE [dbName].tableName (col1 String, col2 String, col3 int,…) STORED BY 'carbondata' TBLPROPERTIES ('CACHE_LEVEL'='Blocklet')
```
Example:
```
- CREATE TABLE employee (name String, city String, id int) STORED BY ‘carbondata’ TBLPROPERTIES (‘CACHE_LEVEL’=’Blocklet’)
+ CREATE TABLE employee (name String, city String, id int) STORED BY 'carbondata' TBLPROPERTIES ('CACHE_LEVEL'='Blocklet')
```
After creation of table or on already created tables use the alter table command to configure the cache level.
@@ -369,26 +392,27 @@ CarbonData DDL statements are documented here,which includes:
Syntax:
```
- ALTER TABLE [dbName].tableName SET TBLPROPERTIES (‘CACHE_LEVEL’=’Blocklet’)
+ ALTER TABLE [dbName].tableName SET TBLPROPERTIES ('CACHE_LEVEL'='Blocklet')
```
Example:
```
- ALTER TABLE employee SET TBLPROPERTIES (‘CACHE_LEVEL’=’Blocklet’)
+ ALTER TABLE employee SET TBLPROPERTIES ('CACHE_LEVEL'='Blocklet')
```
- ##### Support Flat folder same as Hive/Parquet
- 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.
+ 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.
Following table property enables this feature and default value is false.
```
'flat_folder'='true'
```
+
Example:
```
- CREATE TABLE employee (name String, city String, id int) STORED BY ‘carbondata’ TBLPROPERTIES ('flat_folder'='true')
+ CREATE TABLE employee (name String, city String, id int) STORED BY 'carbondata' TBLPROPERTIES ('flat_folder'='true')
```
- ##### String longer than 32000 characters
@@ -418,6 +442,41 @@ CarbonData DDL statements are documented here,which includes:
**NOTE:** The LONG_STRING_COLUMNS can only be string/char/varchar columns and cannot be dictionary_include/sort_columns/complex columns.
+ - ##### Compression for table
+
+ 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:
+
+ ```
+ TBLPROPERTIES('carbon.column.compressor'='snappy')
+ ```
+ or
+ ```
+ TBLPROPERTIES('carbon.column.compressor'='zstd')
+ ```
+ 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:
+ ```
+ carbon.column.compressor=snappy
+ ```
+ or
+ ```
+ carbon.column.compressor=zstd
+ ```
+
+ - ##### Bad Records Path
+ 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.
+
+ ```
+ TBLPROPERTIES('BAD_RECORD_PATH'='/opt/badrecords'')
+ ```
+
## CREATE TABLE AS SELECT
This function allows user to create a Carbon table from any of the Parquet/Hive/Carbon table. This is beneficial when the user wants to create Carbon table from any other Parquet/Hive table and use the Carbon query engine to query and achieve better query results for cases where Carbon is faster than other file formats. Also this feature can be used for backing up the data.
@@ -457,7 +516,7 @@ CarbonData DDL statements are documented here,which includes:
This function allows user to create external table by specifying location.
```
CREATE EXTERNAL TABLE [IF NOT EXISTS] [db_name.]table_name
- STORED AS carbondata LOCATION ‘$FilesPath’
+ STORED AS carbondata LOCATION '$FilesPath'
```
### Create external table on managed table data location.
@@ -510,7 +569,7 @@ CarbonData DDL statements are documented here,which includes:
### Example
```
- CREATE DATABASE carbon LOCATION “hdfs://name_cluster/dir1/carbonstore”;
+ CREATE DATABASE carbon LOCATION "hdfs://name_cluster/dir1/carbonstore";
```
## TABLE MANAGEMENT
@@ -568,21 +627,23 @@ CarbonData DDL statements are documented here,which includes:
```
ALTER TABLE carbon ADD COLUMNS (a1 INT, b1 STRING) TBLPROPERTIES('DEFAULT.VALUE.a1'='10')
```
- NOTE: Add Complex datatype columns is not supported.
+ **NOTE:** Add Complex datatype columns is not supported.
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.
- ```
+ ```
ALTER TABLE carbon ADD COLUMNS (a1 STRING, b1 STRING) TBLPROPERTIES('LOCAL_DICTIONARY_INCLUDE'='a1','LOCAL_DICTIONARY_EXCLUDE'='b1')
- ```
+ ```
- ##### DROP COLUMNS
This command is used to delete the existing column(s) in a table.
+
```
ALTER TABLE [db_name.]table_name DROP COLUMNS (col_name, ...)
```
Examples:
+
```
ALTER TABLE carbon DROP COLUMNS (b1)
OR
@@ -590,12 +651,14 @@ Users can specify which columns to include and exclude for local dictionary gene
ALTER TABLE carbon DROP COLUMNS (c1,d1)
```
- NOTE: Drop Complex child column is not supported.
+
+ **NOTE:** Drop Complex child column is not supported.
- ##### CHANGE DATA TYPE
This command is used to change the data type from INT to BIGINT or decimal precision from lower to higher.
Change of decimal data type from lower precision to higher precision will only be supported for cases where there is no data loss.
+
```
ALTER TABLE [db_name.]table_name CHANGE col_name col_name changed_column_type
```
@@ -606,25 +669,31 @@ Users can specify which columns to include and exclude for local dictionary gene
- **NOTE:** The allowed range is 38,38 (precision, scale) and is a valid upper case scenario which is not resulting in data loss.
Example1:Changing data type of column a1 from INT to BIGINT.
+
```
ALTER TABLE test_db.carbon CHANGE a1 a1 BIGINT
```
Example2:Changing decimal precision of column a1 from 10 to 18.
+
```
ALTER TABLE test_db.carbon CHANGE a1 a1 DECIMAL(18,2)
```
+
- ##### MERGE INDEX
This command is used to merge all the CarbonData index files (.carbonindex) inside a segment to a single CarbonData index merge file (.carbonindexmerge). This enhances the first query performance.
+
```
ALTER TABLE [db_name.]table_name COMPACT 'SEGMENT_INDEX'
```
Examples:
- ```
+
+ ```
ALTER TABLE test_db.carbon COMPACT 'SEGMENT_INDEX'
```
+
**NOTE:**
* Merge index is not supported on streaming table.
@@ -694,10 +763,11 @@ Users can specify which columns to include and exclude for local dictionary gene
```
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')
```
+
You can also SET and UNSET table comment using ALTER command.
Example to SET table comment:
@@ -743,8 +813,8 @@ Users can specify which columns to include and exclude for local dictionary gene
PARTITIONED BY (productCategory STRING, productBatch STRING)
STORED AS carbondata
```
- NOTE: Hive partition is not supported on complex datatype columns.
-
+ **NOTE:** Hive partition is not supported on complex datatype columns.
+
#### Show Partitions
@@ -800,6 +870,7 @@ Users can specify which columns to include and exclude for local dictionary gene
[TBLPROPERTIES ('PARTITION_TYPE'='HASH',
'NUM_PARTITIONS'='N' ...)]
```
+
**NOTE:** N is the number of hash partitions
http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6ad7599a/src/site/markdown/dml-of-carbondata.md
----------------------------------------------------------------------
diff --git a/src/site/markdown/dml-of-carbondata.md b/src/site/markdown/dml-of-carbondata.md
index 42da655..393ebd3 100644
--- a/src/site/markdown/dml-of-carbondata.md
+++ b/src/site/markdown/dml-of-carbondata.md
@@ -46,7 +46,7 @@ CarbonData DML statements are documented here,which includes:
| ------------------------------------------------------- | ------------------------------------------------------------ |
| [DELIMITER](#delimiter) | Character used to separate the data in the input csv file |
| [QUOTECHAR](#quotechar) | Character used to quote the data in the input csv file |
-| [COMMENTCHAR](#commentchar) | Character used to comment the rows in the input csv file.Those rows will be skipped from processing |
+| [COMMENTCHAR](#commentchar) | Character used to comment the rows in the input csv file. Those rows will be skipped from processing |
| [HEADER](#header) | Whether the input csv files have header row |
| [FILEHEADER](#fileheader) | If header is not present in the input csv, what is the column names to be used for data read from input csv |
| [MULTILINE](#multiline) | Whether a row data can span across multiple lines. |
@@ -56,12 +56,12 @@ CarbonData DML statements are documented here,which includes:
| [COMPLEX_DELIMITER_LEVEL_2](#complex_delimiter_level_2) | Ending delimiter for complex type data in input csv file |
| [ALL_DICTIONARY_PATH](#all_dictionary_path) | Path to read the dictionary data from all columns |
| [COLUMNDICT](#columndict) | Path to read the dictionary data from for particular column |
-| [DATEFORMAT](#dateformat) | Format of date in the input csv file |
-| [TIMESTAMPFORMAT](#timestampformat) | Format of timestamp in the input csv file |
+| [DATEFORMAT](#dateformattimestampformat) | Format of date in the input csv file |
+| [TIMESTAMPFORMAT](#dateformattimestampformat) | Format of timestamp in the input csv file |
| [SORT_COLUMN_BOUNDS](#sort-column-bounds) | How to parititon the sort columns to make the evenly distributed |
| [SINGLE_PASS](#single_pass) | When to enable single pass data loading |
| [BAD_RECORDS_LOGGER_ENABLE](#bad-records-handling) | Whether to enable bad records logging |
-| [BAD_RECORD_PATH](#bad-records-handling) | Bad records logging path.Useful when bad record logging is enabled |
+| [BAD_RECORD_PATH](#bad-records-handling) | Bad records logging path. Useful when bad record logging is enabled |
| [BAD_RECORDS_ACTION](#bad-records-handling) | Behavior of data loading when bad record is found |
| [IS_EMPTY_DATA_BAD_RECORD](#bad-records-handling) | Whether empty data of a column to be considered as bad record or not |
| [GLOBAL_SORT_PARTITIONS](#global_sort_partitions) | Number of partition to use for shuffling of data during sorting |
@@ -176,7 +176,7 @@ CarbonData DML statements are documented here,which includes:
Range bounds for sort columns.
- Suppose the table is created with 'SORT_COLUMNS'='name,id' and the range for name is aaa~zzz, the value range for id is 0~1000. Then during data loading, we can specify the following option to enhance data loading performance.
+ 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.
```
OPTIONS('SORT_COLUMN_BOUNDS'='f,250;l,500;r,750')
```
@@ -186,7 +186,7 @@ CarbonData DML statements are documented here,which includes:
* SORT_COLUMN_BOUNDS will be used only when the SORT_SCOPE is 'local_sort'.
* 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.
* 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'.
- * 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.
+ * 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.
* Users can find more information about this option in the description of PR1953.
- ##### SINGLE_PASS:
@@ -240,14 +240,6 @@ CarbonData DML statements are documented here,which includes:
* 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.
- **Bad Records Path:**
- This property is used to specify the location where bad records would be written.
-
-
- ```
- TBLPROPERTIES('BAD_RECORDS_PATH'='/opt/badrecords'')
- ```
-
Example:
```
http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6ad7599a/src/site/markdown/documentation.md
----------------------------------------------------------------------
diff --git a/src/site/markdown/documentation.md b/src/site/markdown/documentation.md
index 537a9d3..1b6726a 100644
--- a/src/site/markdown/documentation.md
+++ b/src/site/markdown/documentation.md
@@ -25,7 +25,7 @@ Apache CarbonData is a new big data file format for faster interactive query usi
## Getting Started
-**File Format Concepts:** Start with the basics of understanding the [CarbonData file format](./file-structure-of-carbondata.md#carbondata-file-format) and its [storage structure](./file-structure-of-carbondata.md).This will help to understand other parts of the documentation, including deployment, programming and usage guides.
+**File Format Concepts:** Start with the basics of understanding the [CarbonData file format](./file-structure-of-carbondata.md#carbondata-file-format) and its [storage structure](./file-structure-of-carbondata.md). This will help to understand other parts of the documentation, including deployment, programming and usage guides.
**Quick Start:** [Run an example program](./quick-start-guide.md#installing-and-configuring-carbondata-to-run-locally-with-spark-shell) on your local machine or [study some examples](https://github.com/apache/carbondata/tree/master/examples/spark2/src/main/scala/org/apache/carbondata/examples).
http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6ad7599a/src/site/markdown/faq.md
----------------------------------------------------------------------
diff --git a/src/site/markdown/faq.md b/src/site/markdown/faq.md
index 8ec7290..3ac9a0a 100644
--- a/src/site/markdown/faq.md
+++ b/src/site/markdown/faq.md
@@ -28,6 +28,7 @@
* [Why aggregate query is not fetching data from aggregate table?](#why-aggregate-query-is-not-fetching-data-from-aggregate-table)
* [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)
* [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)
+* [How to check LRU cache memory footprint?](#how-to-check-lru-cache-memory-footprint)
# TroubleShooting
@@ -56,12 +57,12 @@ By default **carbon.badRecords.location** specifies the following location ``/op
## How to enable Bad Record Logging?
While loading data we can specify the approach to handle Bad Records. In order to analyse the cause of the Bad Records the parameter ``BAD_RECORDS_LOGGER_ENABLE`` must be set to value ``TRUE``. There are multiple approaches to handle Bad Records which can be specified by the parameter ``BAD_RECORDS_ACTION``.
-- To pad the incorrect values of the csv rows with NULL value and load the data in CarbonData, set the following in the query :
+- To pass the incorrect values of the csv rows with NULL value and load the data in CarbonData, set the following in the query :
```
'BAD_RECORDS_ACTION'='FORCE'
```
-- To write the Bad Records without padding incorrect values with NULL in the raw csv (set in the parameter **carbon.badRecords.location**), set the following in the query :
+- To write the Bad Records without passing incorrect values with NULL in the raw csv (set in the parameter **carbon.badRecords.location**), set the following in the query :
```
'BAD_RECORDS_ACTION'='REDIRECT'
```
@@ -198,7 +199,7 @@ select cntry,sum(gdp) from gdp21,pop1 where cntry=ctry group by cntry;
```
## Why all executors are showing success in Spark UI even after Dataload command failed at Driver side?
-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.
+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.
## Why different time zone result for select query output when query SDK writer output?
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.
@@ -212,7 +213,22 @@ cluster timezone is Asia/Shanghai
TimeZone.setDefault(TimeZone.getTimeZone("Asia/Shanghai"))
```
+## How to check LRU cache memory footprint?
+To observe the LRU cache memory footprint in the logs, configure the below properties in log4j.properties file.
+```
+log4j.logger.org.apache.carbondata.core.memory.UnsafeMemoryManager = DEBUG
+log4j.logger.org.apache.carbondata.core.cache.CarbonLRUCache = DEBUG
+```
+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. **Note:** Enabling the DEBUG log will degrade the query performance.
+**Example:**
+```
+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
+```
## Getting tablestatus.lock issues When loading data
http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6ad7599a/src/site/markdown/file-structure-of-carbondata.md
----------------------------------------------------------------------
diff --git a/src/site/markdown/file-structure-of-carbondata.md b/src/site/markdown/file-structure-of-carbondata.md
index 2b43105..8eacd38 100644
--- a/src/site/markdown/file-structure-of-carbondata.md
+++ b/src/site/markdown/file-structure-of-carbondata.md
@@ -48,7 +48,7 @@ The CarbonData files are stored in the location specified by the ***carbon.store
-1. ModifiedTime.mdt records the timestamp of the metadata with the modification time attribute of the file. When the drop table and create table are used, the modification time of the file is updated.This is common to all databases and hence is kept in parallel to databases
+1. ModifiedTime.mdt records the timestamp of the metadata with the modification time attribute of the file. When the drop table and create table are used, the modification time of the file is updated. This is common to all databases and hence is kept in parallel to databases
2. The **default** is the database name and contains the user tables.default is used when user doesn't specify any database name;else user configured database name will be the directory name. user_table is the table name.
3. Metadata directory stores schema files, tablestatus and dictionary files (including .dict, .dictmeta and .sortindex). There are three types of metadata data information files.
4. data and index files are stored under directory named **Fact**. The Fact directory has a Part0 partition directory, where 0 is the partition number.
http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6ad7599a/src/site/markdown/how-to-contribute-to-apache-carbondata.md
----------------------------------------------------------------------
diff --git a/src/site/markdown/how-to-contribute-to-apache-carbondata.md b/src/site/markdown/how-to-contribute-to-apache-carbondata.md
index f64c948..8d6c891 100644
--- a/src/site/markdown/how-to-contribute-to-apache-carbondata.md
+++ b/src/site/markdown/how-to-contribute-to-apache-carbondata.md
@@ -48,7 +48,7 @@ alternatively, on the developer mailing list(dev@carbondata.apache.org).
If there’s an existing JIRA issue for your intended contribution, please comment about your
intended work. Once the work is understood, a committer will assign the issue to you.
-(If you don’t have a JIRA role yet, you’ll be added to the “contributor” role.) If an issue is
+(If you don’t have a JIRA role yet, you’ll be added to the "contributor" role.) If an issue is
currently assigned, please check with the current assignee before reassigning.
For moderate or large contributions, you should not start coding or writing a design doc unless
@@ -171,7 +171,7 @@ Our GitHub mirror automatically provides pre-commit testing coverage using Jenki
Please make sure those tests pass,the contribution cannot be merged otherwise.
#### LGTM
-Once the reviewer is happy with the change, they’ll respond with an LGTM (“looks good to me!”).
+Once the reviewer is happy with the change, they’ll respond with an LGTM ("looks good to me!").
At this point, the committer will take over, possibly make some additional touch ups,
and merge your changes into the codebase.
http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6ad7599a/src/site/markdown/introduction.md
----------------------------------------------------------------------
diff --git a/src/site/markdown/introduction.md b/src/site/markdown/introduction.md
index 434ccfa..e6c3372 100644
--- a/src/site/markdown/introduction.md
+++ b/src/site/markdown/introduction.md
@@ -18,15 +18,15 @@ CarbonData has
## CarbonData Features & Functions
-CarbonData has rich set of featues to support various use cases in Big Data analytics.The below table lists the major features supported by CarbonData.
+CarbonData has rich set of features to support various use cases in Big Data analytics. The below table lists the major features supported by CarbonData.
### Table Management
- ##### DDL (Create, Alter,Drop,CTAS)
-
- CarbonData provides its own DDL to create and manage carbondata tables.These DDL conform to Hive,Spark SQL format and support additional properties and configuration to take advantages of CarbonData functionalities.
+
+ CarbonData provides its own DDL to create and manage carbondata tables. These DDL conform to Hive,Spark SQL format and support additional properties and configuration to take advantages of CarbonData functionalities.
- ##### DML(Load,Insert)
@@ -46,7 +46,7 @@ CarbonData has rich set of featues to support various use cases in Big Data anal
- ##### Compaction
- CarbonData manages incremental loads as segments.Compaction help to compact the growing number of segments and also to improve query filter pruning.
+ CarbonData manages incremental loads as segments. Compaction helps to compact the growing number of segments and also to improve query filter pruning.
- ##### External Tables
@@ -56,11 +56,11 @@ CarbonData has rich set of featues to support various use cases in Big Data anal
- ##### Pre-Aggregate
- CarbonData has concept of datamaps to assist in pruning of data while querying so that performance is faster.Pre Aggregate tables are kind of datamaps which can improve the query performance by order of magnitude.CarbonData will automatically pre-aggregae the incremental data and re-write the query to automatically fetch from the most appropriate pre-aggregate table to serve the query faster.
+ CarbonData has concept of datamaps to assist in pruning of data while querying so that performance is faster.Pre Aggregate tables are kind of datamaps which can improve the query performance by order of magnitude.CarbonData will automatically pre-aggregate the incremental data and re-write the query to automatically fetch from the most appropriate pre-aggregate table to serve the query faster.
- ##### Time Series
- CarbonData has built in understanding of time order(Year, month,day,hour, minute,second).Time series is a pre-aggregate table which can automatically roll-up the data to the desired level during incremental load and serve the query from the most appropriate pre-aggregate table.
+ CarbonData has built in understanding of time order(Year, month,day,hour, minute,second). Time series is a pre-aggregate table which can automatically roll-up the data to the desired level during incremental load and serve the query from the most appropriate pre-aggregate table.
- ##### Bloom filter
@@ -72,7 +72,7 @@ CarbonData has rich set of featues to support various use cases in Big Data anal
- ##### MV (Materialized Views)
- MVs are kind of pre-aggregate tables which can support efficent query re-write and processing.CarbonData provides MV which can rewrite query to fetch from any table(including non-carbondata tables).Typical usecase is to store the aggregated data of a non-carbondata fact table into carbondata and use mv to rewrite the query to fetch from carbondata.
+ MVs are kind of pre-aggregate tables which can support efficent query re-write and processing.CarbonData provides MV which can rewrite query to fetch from any table(including non-carbondata tables). Typical usecase is to store the aggregated data of a non-carbondata fact table into carbondata and use mv to rewrite the query to fetch from carbondata.
### Streaming
@@ -84,17 +84,17 @@ CarbonData has rich set of featues to support various use cases in Big Data anal
- ##### CarbonData writer
- CarbonData supports writing data from non-spark application using SDK.Users can use SDK to generate carbondata files from custom applications.Typical usecase is to write the streaming application plugged in to kafka and use carbondata as sink(target) table for storing.
+ CarbonData supports writing data from non-spark application using SDK.Users can use SDK to generate carbondata files from custom applications. Typical usecase is to write the streaming application plugged in to kafka and use carbondata as sink(target) table for storing.
- ##### CarbonData reader
- CarbonData supports reading of data from non-spark application using SDK.Users can use the SDK to read the carbondata files from their application and do custom processing.
+ CarbonData supports reading of data from non-spark application using SDK. Users can use the SDK to read the carbondata files from their application and do custom processing.
### Storage
- ##### S3
- CarbonData can write to S3, OBS or any cloud storage confirming to S3 protocol.CarbonData uses the HDFS api to write to cloud object stores.
+ CarbonData can write to S3, OBS or any cloud storage confirming to S3 protocol. CarbonData uses the HDFS api to write to cloud object stores.
- ##### HDFS
http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6ad7599a/src/site/markdown/language-manual.md
----------------------------------------------------------------------
diff --git a/src/site/markdown/language-manual.md b/src/site/markdown/language-manual.md
index 123cae3..79aad00 100644
--- a/src/site/markdown/language-manual.md
+++ b/src/site/markdown/language-manual.md
@@ -32,8 +32,10 @@ CarbonData has its own parser, in addition to Spark's SQL Parser, to parse and p
- Materialized Views (MV)
- [Streaming](./streaming-guide.md)
- Data Manipulation Statements
- - [DML:](./dml-of-carbondata.md) [Load](./dml-of-carbondata.md#load-data), [Insert](./ddl-of-carbondata.md#insert-overwrite), [Update](./dml-of-carbondata.md#update), [Delete](./dml-of-carbondata.md#delete)
+ - [DML:](./dml-of-carbondata.md) [Load](./dml-of-carbondata.md#load-data), [Insert](./dml-of-carbondata.md#insert-data-into-carbondata-table), [Update](./dml-of-carbondata.md#update), [Delete](./dml-of-carbondata.md#delete)
- [Segment Management](./segment-management-on-carbondata.md)
+- [CarbonData as Spark's Datasource](./carbon-as-spark-datasource-guide.md)
- [Configuration Properties](./configuration-parameters.md)
+
http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6ad7599a/src/site/markdown/lucene-datamap-guide.md
----------------------------------------------------------------------
diff --git a/src/site/markdown/lucene-datamap-guide.md b/src/site/markdown/lucene-datamap-guide.md
index 86b00e2..aa9c8d4 100644
--- a/src/site/markdown/lucene-datamap-guide.md
+++ b/src/site/markdown/lucene-datamap-guide.md
@@ -47,7 +47,7 @@ It will show all DataMaps created on main table.
## Lucene DataMap Introduction
Lucene is a high performance, full featured text search engine. Lucene is integrated to carbon as
- an index datamap and managed along with main tables by CarbonData.User can create lucene datamap
+ an index datamap and managed along with main tables by CarbonData. User can create lucene datamap
to improve query performance on string columns which has content of more length. So, user can
search tokenized word or pattern of it using lucene query on text content.
@@ -95,7 +95,7 @@ As a technique for query acceleration, Lucene indexes cannot be queried directly
Queries are to be made on main table. when a query with TEXT_MATCH('name:c10') or
TEXT_MATCH_WITH_LIMIT('name:n10',10)[the second parameter represents the number of result to be
returned, if user does not specify this value, all results will be returned without any limit] is
-fired, two jobs are fired.The first job writes the temporary files in folder created at table level
+fired, two jobs are fired. The first job writes the temporary files in folder created at table level
which contains lucene's seach results and these files will be read in second job to give faster
results. These temporary files will be cleared once the query finishes.
http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6ad7599a/src/site/markdown/performance-tuning.md
----------------------------------------------------------------------
diff --git a/src/site/markdown/performance-tuning.md b/src/site/markdown/performance-tuning.md
index f56a63b..6c87ce9 100644
--- a/src/site/markdown/performance-tuning.md
+++ b/src/site/markdown/performance-tuning.md
@@ -140,7 +140,7 @@
| Parameter | Default Value | Description/Tuning |
|-----------|-------------|--------|
-|carbon.number.of.cores.while.loading|Default: 2.This value should be >= 2|Specifies the number of cores used for data processing during data loading in CarbonData. |
+|carbon.number.of.cores.while.loading|Default: 2. This value should be >= 2|Specifies the number of cores used for data processing during data loading in CarbonData. |
|carbon.sort.size|Default: 100000. The value should be >= 100.|Threshold to write local file in sort step when loading data|
|carbon.sort.file.write.buffer.size|Default: 50000.|DataOutputStream buffer. |
|carbon.merge.sort.reader.thread|Default: 3 |Specifies the number of cores used for temp file merging during data loading in CarbonData.|
@@ -165,15 +165,15 @@
|----------------------------------------------|-----------------------------------|---------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| carbon.sort.intermediate.files.limit | spark/carbonlib/carbon.properties | Data loading | During the loading of data, local temp is used to sort the data. This number specifies the minimum number of intermediate files after which the merge sort has to be initiated. | Increasing the parameter to a higher value will improve the load performance. For example, when we increase the value from 20 to 100, it increases the data load performance from 35MB/S to more than 50MB/S. Higher values of this parameter consumes more memory during the load. |
| carbon.number.of.cores.while.loading | spark/carbonlib/carbon.properties | Data loading | Specifies the number of cores used for data processing during data loading in CarbonData. | If you have more number of CPUs, then you can increase the number of CPUs, which will increase the performance. For example if we increase the value from 2 to 4 then the CSV reading performance can increase about 1 times |
-| carbon.compaction.level.threshold | spark/carbonlib/carbon.properties | Data loading and Querying | For minor compaction, specifies the number of segments to be merged in stage 1 and number of compacted segments to be merged in stage 2. | Each CarbonData load will create one segment, if every load is small in size it will generate many small file over a period of time impacting the query performance. Configuring this parameter will merge the small segment to one big segment which will sort the data and improve the performance. For Example in one telecommunication scenario, the performance improves about 2 times after minor compaction. |
+| carbon.compaction.level.threshold | spark/carbonlib/carbon.properties | Data loading and Querying | For minor compaction, specifies the number of segments to be merged in stage 1 and number of compacted segments to be merged in stage 2. | Each CarbonData load will create one segment, if every load is small in size it will generate many small files over a period of time impacting the query performance. Configuring this parameter will merge the small segment to one big segment which will sort the data and improve the performance. For Example in one telecommunication scenario, the performance improves about 2 times after minor compaction. |
| spark.sql.shuffle.partitions | spark/conf/spark-defaults.conf | Querying | The number of task started when spark shuffle. | The value can be 1 to 2 times as much as the executor cores. In an aggregation scenario, reducing the number from 200 to 32 reduced the query time from 17 to 9 seconds. |
| spark.executor.instances/spark.executor.cores/spark.executor.memory | spark/conf/spark-defaults.conf | Querying | The number of executors, CPU cores, and memory used for CarbonData query. | In the bank scenario, we provide the 4 CPUs cores and 15 GB for each executor which can get good performance. This 2 value does not mean more the better. It needs to be configured properly in case of limited resources. For example, In the bank scenario, it has enough CPU 32 cores each node but less memory 64 GB each node. So we cannot give more CPU but less memory. For example, when 4 cores and 12GB for each executor. It sometimes happens GC during the query which impact the query performance very much from the 3 second to more than 15 seconds. In this scenario need to increase the memory or decrease the CPU cores. |
| carbon.detail.batch.size | spark/carbonlib/carbon.properties | Data loading | The buffer size to store records, returned from the block scan. | In limit scenario this parameter is very important. For example your query limit is 1000. But if we set this value to 3000 that means we get 3000 records from scan but spark will only take 1000 rows. So the 2000 remaining are useless. In one Finance test case after we set it to 100, in the limit 1000 scenario the performance increase about 2 times in comparison to if we set this value to 12000. |
| carbon.use.local.dir | spark/carbonlib/carbon.properties | Data loading | Whether use YARN local directories for multi-table load disk load balance | If this is set it to true CarbonData will use YARN local directories for multi-table load disk load balance, that will improve the data load performance. |
| carbon.use.multiple.temp.dir | spark/carbonlib/carbon.properties | Data loading | Whether to use multiple YARN local directories during table data loading for disk load balance | After enabling 'carbon.use.local.dir', if this is set to true, CarbonData will use all YARN local directories during data load for disk load balance, that will improve the data load performance. Please enable this property when you encounter disk hotspot problem during data loading. |
-| carbon.sort.temp.compressor | spark/carbonlib/carbon.properties | Data loading | Specify the name of compressor to compress the intermediate sort temporary files during sort procedure in data loading. | The optional values are 'SNAPPY','GZIP','BZIP2','LZ4','ZSTD' and empty. By default, empty means that Carbondata will not compress the sort temp files. This parameter will be useful if you encounter disk bottleneck. |
-| carbon.load.skewedDataOptimization.enabled | spark/carbonlib/carbon.properties | Data loading | Whether to enable size based block allocation strategy for data loading. | When loading, carbondata will use file size based block allocation strategy for task distribution. It will make sure that all the executors process the same size of data -- It's useful if the size of your input data files varies widely, say 1MB~1GB. |
-| carbon.load.min.size.enabled | spark/carbonlib/carbon.properties | Data loading | Whether to enable node minumun input data size allocation strategy for data loading.| When loading, carbondata will use node minumun input data size allocation strategy for task distribution. It will make sure the node load the minimum amount of data -- It's useful if the size of your input data files very small, say 1MB~256MB,Avoid generating a large number of small files. |
+| carbon.sort.temp.compressor | spark/carbonlib/carbon.properties | Data loading | Specify the name of compressor to compress the intermediate sort temporary files during sort procedure in data loading. | The optional values are 'SNAPPY','GZIP','BZIP2','LZ4','ZSTD', and empty. By default, empty means that Carbondata will not compress the sort temp files. This parameter will be useful if you encounter disk bottleneck. |
+| carbon.load.skewedDataOptimization.enabled | spark/carbonlib/carbon.properties | Data loading | Whether to enable size based block allocation strategy for data loading. | When loading, carbondata will use file size based block allocation strategy for task distribution. It will make sure that all the executors process the same size of data -- It's useful if the size of your input data files varies widely, say 1MB to 1GB. |
+| carbon.load.min.size.enabled | spark/carbonlib/carbon.properties | Data loading | Whether to enable node minumun input data size allocation strategy for data loading.| When loading, carbondata will use node minumun input data size allocation strategy for task distribution. It will make sure the nodes load the minimum amount of data -- It's useful if the size of your input data files very small, say 1MB to 256MB,Avoid generating a large number of small files. |
Note: If your CarbonData instance is provided only for query, you may specify the property 'spark.speculation=true' which is in conf directory of spark.
http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6ad7599a/src/site/markdown/preaggregate-datamap-guide.md
----------------------------------------------------------------------
diff --git a/src/site/markdown/preaggregate-datamap-guide.md b/src/site/markdown/preaggregate-datamap-guide.md
index 3a3efc2..eff601d 100644
--- a/src/site/markdown/preaggregate-datamap-guide.md
+++ b/src/site/markdown/preaggregate-datamap-guide.md
@@ -251,7 +251,7 @@ pre-aggregate tables. To further improve the query performance, compaction on pr
can be triggered to merge the segments and files in the pre-aggregate tables.
## Data Management with pre-aggregate tables
-In current implementation, data consistence need to be maintained for both main table and pre-aggregate
+In current implementation, data consistency needs to be maintained for both main table and pre-aggregate
tables. Once there is pre-aggregate table created on the main table, following command on the main
table
is not supported:
http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6ad7599a/src/site/markdown/quick-start-guide.md
----------------------------------------------------------------------
diff --git a/src/site/markdown/quick-start-guide.md b/src/site/markdown/quick-start-guide.md
index 37c398c..fd535ae 100644
--- a/src/site/markdown/quick-start-guide.md
+++ b/src/site/markdown/quick-start-guide.md
@@ -16,7 +16,7 @@
-->
# Quick Start
-This tutorial provides a quick introduction to using CarbonData.To follow along with this guide, first download a packaged release of CarbonData from the [CarbonData website](https://dist.apache.org/repos/dist/release/carbondata/).Alternatively it can be created following [Building CarbonData](https://github.com/apache/carbondata/tree/master/build) steps.
+This tutorial provides a quick introduction to using CarbonData. To follow along with this guide, first download a packaged release of CarbonData from the [CarbonData website](https://dist.apache.org/repos/dist/release/carbondata/).Alternatively it can be created following [Building CarbonData](https://github.com/apache/carbondata/tree/master/build) steps.
## Prerequisites
* CarbonData supports Spark versions upto 2.2.1.Please download Spark package from [Spark website](https://spark.apache.org/downloads.html)
@@ -35,7 +35,7 @@ This tutorial provides a quick introduction to using CarbonData.To follow along
## Integration
-CarbonData can be integrated with Spark and Presto Execution Engines.The below documentation guides on Installing and Configuring with these execution engines.
+CarbonData can be integrated with Spark and Presto Execution Engines. The below documentation guides on Installing and Configuring with these execution engines.
### Spark
@@ -293,31 +293,31 @@ hdfs://<host_name>:port/user/hive/warehouse/carbon.store
## Installing and Configuring CarbonData on Presto
-**NOTE:** **CarbonData tables cannot be created nor loaded from Presto.User need to create CarbonData Table and load data into it
+**NOTE:** **CarbonData tables cannot be created nor loaded from Presto. User need to create CarbonData Table and load data into it
either with [Spark](#installing-and-configuring-carbondata-to-run-locally-with-spark-shell) or [SDK](./sdk-guide.md).
Once the table is created,it can be queried from Presto.**
### Installing Presto
- 1. Download the 0.187 version of Presto using:
- `wget https://repo1.maven.org/maven2/com/facebook/presto/presto-server/0.187/presto-server-0.187.tar.gz`
+ 1. Download the 0.210 version of Presto using:
+ `wget https://repo1.maven.org/maven2/com/facebook/presto/presto-server/0.210/presto-server-0.210.tar.gz`
- 2. Extract Presto tar file: `tar zxvf presto-server-0.187.tar.gz`.
+ 2. Extract Presto tar file: `tar zxvf presto-server-0.210.tar.gz`.
3. Download the Presto CLI for the coordinator and name it presto.
```
- wget https://repo1.maven.org/maven2/com/facebook/presto/presto-cli/0.187/presto-cli-0.187-executable.jar
+ wget https://repo1.maven.org/maven2/com/facebook/presto/presto-cli/0.210/presto-cli-0.210-executable.jar
- mv presto-cli-0.187-executable.jar presto
+ mv presto-cli-0.210-executable.jar presto
chmod +x presto
```
### Create Configuration Files
- 1. Create `etc` folder in presto-server-0.187 directory.
+ 1. Create `etc` folder in presto-server-0.210 directory.
2. Create `config.properties`, `jvm.config`, `log.properties`, and `node.properties` files.
3. Install uuid to generate a node.id.
@@ -363,10 +363,15 @@ Once the table is created,it can be queried from Presto.**
coordinator=true
node-scheduler.include-coordinator=false
http-server.http.port=8086
- query.max-memory=50GB
- query.max-memory-per-node=2GB
+ query.max-memory=5GB
+ query.max-total-memory-per-node=5GB
+ query.max-memory-per-node=3GB
+ memory.heap-headroom-per-node=1GB
discovery-server.enabled=true
- discovery.uri=<coordinator_ip>:8086
+ discovery.uri=http://localhost:8086
+ task.max-worker-threads=4
+ optimizer.dictionary-aggregation=true
+ optimizer.optimize-hash-generation = false
```
The options `node-scheduler.include-coordinator=false` and `coordinator=true` indicate that the node is the coordinator and tells the coordinator not to do any of the computation work itself and to use the workers.
@@ -383,7 +388,7 @@ Then, `query.max-memory=<30GB * number of nodes>`.
```
coordinator=false
http-server.http.port=8086
- query.max-memory=50GB
+ query.max-memory=5GB
query.max-memory-per-node=2GB
discovery.uri=<coordinator_ip>:8086
```
@@ -405,12 +410,12 @@ Then, `query.max-memory=<30GB * number of nodes>`.
### Start Presto Server on all nodes
```
-./presto-server-0.187/bin/launcher start
+./presto-server-0.210/bin/launcher start
```
To run it as a background process.
```
-./presto-server-0.187/bin/launcher run
+./presto-server-0.210/bin/launcher run
```
To run it in foreground.
http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6ad7599a/src/site/markdown/s3-guide.md
----------------------------------------------------------------------
diff --git a/src/site/markdown/s3-guide.md b/src/site/markdown/s3-guide.md
index a2e5f07..1121164 100644
--- a/src/site/markdown/s3-guide.md
+++ b/src/site/markdown/s3-guide.md
@@ -15,7 +15,7 @@
limitations under the License.
-->
-# S3 Guide (Alpha Feature 1.4.1)
+# S3 Guide
Object storage is the recommended storage format in cloud as it can support storing large data
files. S3 APIs are widely used for accessing object stores. This can be
[07/20] carbondata-site git commit: modified for 1.5.0 version
Posted by ch...@apache.org.
http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6ad7599a/src/main/webapp/carbon-as-spark-datasource-guide.html
----------------------------------------------------------------------
diff --git a/src/main/webapp/carbon-as-spark-datasource-guide.html b/src/main/webapp/carbon-as-spark-datasource-guide.html
new file mode 100644
index 0000000..e29f120
--- /dev/null
+++ b/src/main/webapp/carbon-as-spark-datasource-guide.html
@@ -0,0 +1,349 @@
+<!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>
+ <script defer src="https://use.fontawesome.com/releases/v5.0.8/js/all.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.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>
+ <a href="https://dist.apache.org/repos/dist/release/carbondata/1.4.0/"
+ target="_blank">Apache CarbonData 1.4.0</a></li>
+ <li>
+ <a href="https://dist.apache.org/repos/dist/release/carbondata/1.3.1/"
+ target="_blank">Apache CarbonData 1.3.1</a></li>
+ <li>
+ <a href="https://dist.apache.org/repos/dist/release/carbondata/1.3.0/"
+ target="_blank">Apache CarbonData 1.3.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="documentation.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="verticalnavbar">
+ <nav class="b-sticky-nav">
+ <div class="nav-scroller">
+ <div class="nav__inner">
+ <a class="b-nav__intro nav__item" href="./introduction.html">introduction</a>
+ <a class="b-nav__quickstart nav__item" href="./quick-start-guide.html">quick start</a>
+ <a class="b-nav__uses nav__item" href="./usecases.html">use cases</a>
+
+ <div class="nav__item nav__item__with__subs">
+ <a class="b-nav__docs nav__item nav__sub__anchor" href="./language-manual.html">Language Reference</a>
+ <a class="nav__item nav__sub__item" href="./ddl-of-carbondata.html">DDL</a>
+ <a class="nav__item nav__sub__item" href="./dml-of-carbondata.html">DML</a>
+ <a class="nav__item nav__sub__item" href="./streaming-guide.html">Streaming</a>
+ <a class="nav__item nav__sub__item" href="./configuration-parameters.html">Configuration</a>
+ <a class="nav__item nav__sub__item" href="./datamap-developer-guide.html">Datamaps</a>
+ <a class="nav__item nav__sub__item" href="./supported-data-types-in-carbondata.html">Data Types</a>
+ </div>
+
+ <div class="nav__item nav__item__with__subs">
+ <a class="b-nav__datamap nav__item nav__sub__anchor" href="./datamap-management.html">DataMaps</a>
+ <a class="nav__item nav__sub__item" href="./bloomfilter-datamap-guide.html">Bloom Filter</a>
+ <a class="nav__item nav__sub__item" href="./lucene-datamap-guide.html">Lucene</a>
+ <a class="nav__item nav__sub__item" href="./preaggregate-datamap-guide.html">Pre-Aggregate</a>
+ <a class="nav__item nav__sub__item" href="./timeseries-datamap-guide.html">Time Series</a>
+ </div>
+
+ <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>
+ <a class="b-nav__contri nav__item" href="./how-to-contribute-to-apache-carbondata.html">Contribute</a>
+ <a class="b-nav__security nav__item" href="./security.html">Security</a>
+ <a class="b-nav__release nav__item" href="./release-guide.html">Release Guide</a>
+ </div>
+ </div>
+ <div class="navindicator">
+ <div class="b-nav__intro navindicator__item"></div>
+ <div class="b-nav__quickstart navindicator__item"></div>
+ <div class="b-nav__uses navindicator__item"></div>
+ <div class="b-nav__docs navindicator__item"></div>
+ <div class="b-nav__datamap navindicator__item"></div>
+ <div class="b-nav__api navindicator__item"></div>
+ <div class="b-nav__perf navindicator__item"></div>
+ <div class="b-nav__s3 navindicator__item"></div>
+ <div class="b-nav__faq navindicator__item"></div>
+ <div class="b-nav__contri navindicator__item"></div>
+ <div class="b-nav__security navindicator__item"></div>
+ </div>
+ </nav>
+ </div>
+ <div class="mdcontent">
+ <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="carbondata-as-sparks-datasource" class="anchor" href="#carbondata-as-sparks-datasource" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>CarbonData as Spark's Datasource</h1>
+<p>The CarbonData fileformat is now integrated as Spark datasource for read and write operation without using CarbonSession. This is useful for users who wants to use carbondata as spark's data source.</p>
+<p><strong>Note:</strong> You can only apply the functions/features supported by spark datasource APIs, functionalities supported would be similar to Parquet. The carbon session features are not supported.</p>
+<h1>
+<a id="create-table-with-ddl" class="anchor" href="#create-table-with-ddl" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Create Table with DDL</h1>
+<p>Now you can create Carbon table using Spark's datasource DDL syntax.</p>
+<pre><code> CREATE [TEMPORARY] TABLE [IF NOT EXISTS] [db_name.]table_name
+ [(col_name1 col_type1 [COMMENT col_comment1], ...)]
+ USING CARBON
+ [OPTIONS (key1=val1, key2=val2, ...)]
+ [PARTITIONED BY (col_name1, col_name2, ...)]
+ [CLUSTERED BY (col_name3, col_name4, ...) INTO num_buckets BUCKETS]
+ [LOCATION path]
+ [COMMENT table_comment]
+ [TBLPROPERTIES (key1=val1, key2=val2, ...)]
+ [AS select_statement]
+</code></pre>
+<h2>
+<a id="supported-options" class="anchor" href="#supported-options" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Supported OPTIONS</h2>
+<table>
+<thead>
+<tr>
+<th>Property</th>
+<th>Default Value</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>table_blocksize</td>
+<td>1024</td>
+<td>Size of blocks to write onto hdfs. For more details, see <a href="./ddl-of-carbondata.html#table-block-size-configuration">Table Block Size Configuration</a>.</td>
+</tr>
+<tr>
+<td>table_blocklet_size</td>
+<td>64</td>
+<td>Size of blocklet to write.</td>
+</tr>
+<tr>
+<td>local_dictionary_threshold</td>
+<td>10000</td>
+<td>Cardinality upto which the local dictionary can be generated. For more details, see <a href="./ddl-of-carbondata.html#local-dictionary-configuration">Local Dictionary Configuration</a>.</td>
+</tr>
+<tr>
+<td>local_dictionary_enable</td>
+<td>false</td>
+<td>Enable local dictionary generation. For more details, see <a href="./ddl-of-carbondata.html#local-dictionary-configuration">Local Dictionary Configuration</a>.</td>
+</tr>
+<tr>
+<td>sort_columns</td>
+<td>all dimensions are sorted</td>
+<td>Columns to include in sort and its order of sort. For more details, see <a href="./ddl-of-carbondata.html#sort-columns-configuration">Sort Columns Configuration</a>.</td>
+</tr>
+<tr>
+<td>sort_scope</td>
+<td>local_sort</td>
+<td>Sort scope of the load.Options include no sort, local sort, batch sort, and global sort. For more details, see <a href="./ddl-of-carbondata.html#sort-scope-configuration">Sort Scope Configuration</a>.</td>
+</tr>
+<tr>
+<td>long_string_columns</td>
+<td>null</td>
+<td>Comma separated string/char/varchar columns which are more than 32k length. For more details, see <a href="./ddl-of-carbondata.html#string-longer-than-32000-characters">String longer than 32000 characters</a>.</td>
+</tr>
+</tbody>
+</table>
+<h2>
+<a id="example" class="anchor" href="#example" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Example</h2>
+<pre><code> CREATE TABLE CARBON_TABLE (NAME STRING) USING CARBON OPTIONS('table_block_size'='256')
+</code></pre>
+<h1>
+<a id="using-dataframe" class="anchor" href="#using-dataframe" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Using DataFrame</h1>
+<p>Carbon format can be used in dataframe also. Following are the ways to use carbon format in dataframe.</p>
+<p>Write carbon using dataframe</p>
+<pre><code>df.write.format("carbon").save(path)
+</code></pre>
+<p>Read carbon using dataframe</p>
+<pre><code>val df = spark.read.format("carbon").load(path)
+</code></pre>
+<h2>
+<a id="example-1" class="anchor" href="#example-1" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Example</h2>
+<pre><code>import org.apache.spark.sql.SparkSession
+
+val spark = SparkSession
+ .builder()
+ .appName("Spark SQL basic example")
+ .config("spark.some.config.option", "some-value")
+ .getOrCreate()
+
+// For implicit conversions like converting RDDs to DataFrames
+import spark.implicits._
+val df = spark.sparkContext.parallelize(1 to 10 * 10 * 1000)
+ .map(x => (r.nextInt(100000), "name" + x % 8, "city" + x % 50, BigDecimal.apply(x % 60)))
+ .toDF("ID", "name", "city", "age")
+
+// Write to carbon format
+df.write.format("carbon").save("/user/person_table")
+
+// Read carbon using dataframe
+val dfread = spark.read.format("carbon").load("/user/person_table")
+dfread.show()
+</code></pre>
+<p>Reference : <a href="./configuration-parameters.html">list of carbon properties</a></p>
+<script>
+$(function() {
+ // Show selected style on nav item
+ $('.b-nav__docs').addClass('selected');
+
+ // Display docs subnav items
+ if (!$('.b-nav__docs').parent().hasClass('nav__item__with__subs--expanded')) {
+ $('.b-nav__docs').parent().toggleClass('nav__item__with__subs--expanded');
+ }
+});
+</script></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
[05/20] carbondata-site git commit: modified for 1.5.0 version
Posted by ch...@apache.org.
http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6ad7599a/src/main/webapp/css/style.css
----------------------------------------------------------------------
diff --git a/src/main/webapp/css/style.css b/src/main/webapp/css/style.css
index 88fd05f..719f72d 100644
--- a/src/main/webapp/css/style.css
+++ b/src/main/webapp/css/style.css
@@ -1307,6 +1307,11 @@ width:80%;
padding-left:30px;
}
+@media screen and (min-width: 1690px) {
+ .verticalnavbar{
+ width: 11% !important;}
+}
+
.verticalnavbar {
float: left;
text-transform: uppercase;
http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6ad7599a/src/main/webapp/datamap-developer-guide.html
----------------------------------------------------------------------
diff --git a/src/main/webapp/datamap-developer-guide.html b/src/main/webapp/datamap-developer-guide.html
index 4b9aa4b..50ac30f 100644
--- a/src/main/webapp/datamap-developer-guide.html
+++ b/src/main/webapp/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/src/main/webapp/datamap-management.html
----------------------------------------------------------------------
diff --git a/src/main/webapp/datamap-management.html b/src/main/webapp/datamap-management.html
index e2e89f3..ad22bb8 100644
--- a/src/main/webapp/datamap-management.html
+++ b/src/main/webapp/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/src/main/webapp/ddl-of-carbondata.html
----------------------------------------------------------------------
diff --git a/src/main/webapp/ddl-of-carbondata.html b/src/main/webapp/ddl-of-carbondata.html
index 2582f4d..635d835 100644
--- a/src/main/webapp/ddl-of-carbondata.html
+++ b/src/main/webapp/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>
http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6ad7599a/src/main/webapp/dml-of-carbondata.html
----------------------------------------------------------------------
diff --git a/src/main/webapp/dml-of-carbondata.html b/src/main/webapp/dml-of-carbondata.html
index ac41f7c..e658a68 100644
--- a/src/main/webapp/dml-of-carbondata.html
+++ b/src/main/webapp/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/src/main/webapp/documentation.html
----------------------------------------------------------------------
diff --git a/src/main/webapp/documentation.html b/src/main/webapp/documentation.html
index 982becf..c920945 100644
--- a/src/main/webapp/documentation.html
+++ b/src/main/webapp/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/src/main/webapp/faq.html
----------------------------------------------------------------------
diff --git a/src/main/webapp/faq.html b/src/main/webapp/faq.html
index c37284f..aac986c 100644
--- a/src/main/webapp/faq.html
+++ b/src/main/webapp/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)
http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6ad7599a/src/main/webapp/file-structure-of-carbondata.html
----------------------------------------------------------------------
diff --git a/src/main/webapp/file-structure-of-carbondata.html b/src/main/webapp/file-structure-of-carbondata.html
index c14ea6d..bd2be65 100644
--- a/src/main/webapp/file-structure-of-carbondata.html
+++ b/src/main/webapp/file-structure-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>
@@ -249,7 +257,7 @@
<p>The file directory structure is as below:</p>
<p><a href="../docs/images/2-1_1.png?raw=true" target="_blank" rel="noopener noreferrer"><img src="https://github.com/apache/carbondata/blob/master/docs/images/2-1_1.png?raw=true" alt="File Directory Structure" style="max-width:100%;"></a></p>
<ol>
-<li>ModifiedTime.htmlt records the timestamp of the metadata with the modification time attribute of the file. When the drop table and create table are used, the modification time of the file is updated.This is common to all databases and hence is kept in parallel to databases</li>
+<li>ModifiedTime.htmlt records the timestamp of the metadata with the modification time attribute of the file. When the drop table and create table are used, the modification time of the file is updated. This is common to all databases and hence is kept in parallel to databases</li>
<li>The <strong>default</strong> is the database name and contains the user tables.default is used when user doesn't specify any database name;else user configured database name will be the directory name. user_table is the table name.</li>
<li>Metadata directory stores schema files, tablestatus and dictionary files (including .dict, .dictmeta and .sortindex). There are three types of metadata data information files.</li>
<li>data and index files are stored under directory named <strong>Fact</strong>. The Fact directory has a Part0 partition directory, where 0 is the partition number.</li>
http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6ad7599a/src/main/webapp/how-to-contribute-to-apache-carbondata.html
----------------------------------------------------------------------
diff --git a/src/main/webapp/how-to-contribute-to-apache-carbondata.html b/src/main/webapp/how-to-contribute-to-apache-carbondata.html
index 122b763..392814c 100644
--- a/src/main/webapp/how-to-contribute-to-apache-carbondata.html
+++ b/src/main/webapp/how-to-contribute-to-apache-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>
@@ -238,7 +246,7 @@ create it. Please discuss your proposal with a committer or the component lead i
alternatively, on the developer mailing list(<a href="mailto:dev@carbondata.apache.org">dev@carbondata.apache.org</a>).</p>
<p>If there?s an existing JIRA issue for your intended contribution, please comment about your
intended work. Once the work is understood, a committer will assign the issue to you.
-(If you don?t have a JIRA role yet, you?ll be added to the ?contributor? role.) If an issue is
+(If you don?t have a JIRA role yet, you?ll be added to the "contributor" role.) If an issue is
currently assigned, please check with the current assignee before reassigning.</p>
<p>For moderate or large contributions, you should not start coding or writing a design doc unless
there is a corresponding JIRA issue assigned to you for that work. Simple changes,
@@ -334,7 +342,7 @@ When you make a revision, always push it in a new commit.</p>
Please make sure those tests pass,the contribution cannot be merged otherwise.</p>
<h4>
<a id="lgtm" class="anchor" href="#lgtm" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>LGTM</h4>
-<p>Once the reviewer is happy with the change, they?ll respond with an LGTM (?looks good to me!?).
+<p>Once the reviewer is happy with the change, they?ll respond with an LGTM ("looks good to me!").
At this point, the committer will take over, possibly make some additional touch ups,
and merge your changes into the codebase.</p>
<p>In the case both the author and the reviewer are committers, either can merge the pull request.
http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6ad7599a/src/main/webapp/introduction.html
----------------------------------------------------------------------
diff --git a/src/main/webapp/introduction.html b/src/main/webapp/introduction.html
index 068d711..8f18870 100644
--- a/src/main/webapp/introduction.html
+++ b/src/main/webapp/introduction.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,17 +237,15 @@
</ul>
<h2>
<a id="carbondata-features--functions" class="anchor" href="#carbondata-features--functions" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>CarbonData Features & Functions</h2>
-<p>CarbonData has rich set of featues to support various use cases in Big Data analytics.The below table lists the major features supported by CarbonData.</p>
+<p>CarbonData has rich set of features to support various use cases in Big Data analytics. The below table lists the major features supported by CarbonData.</p>
<h3>
<a id="table-management" class="anchor" href="#table-management" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Table Management</h3>
<ul>
<li>
<h5>
<a id="ddl-create-alterdropctas" class="anchor" href="#ddl-create-alterdropctas" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>DDL (Create, Alter,Drop,CTAS)</h5>
+<p>CarbonData provides its own DDL to create and manage carbondata tables. These DDL conform to Hive,Spark SQL format and support additional properties and configuration to take advantages of CarbonData functionalities.</p>
</li>
-</ul>
-<p>? CarbonData provides its own DDL to create and manage carbondata tables.These DDL conform to Hive,Spark SQL format and support additional properties and configuration to take advantages of CarbonData functionalities.</p>
-<ul>
<li>
<h5>
<a id="dmlloadinsert" class="anchor" href="#dmlloadinsert" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>DML(Load,Insert)</h5>
@@ -263,7 +269,7 @@
<li>
<h5>
<a id="compaction" class="anchor" href="#compaction" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Compaction</h5>
-<p>CarbonData manages incremental loads as segments.Compaction help to compact the growing number of segments and also to improve query filter pruning.</p>
+<p>CarbonData manages incremental loads as segments. Compaction helps to compact the growing number of segments and also to improve query filter pruning.</p>
</li>
<li>
<h5>
@@ -277,12 +283,12 @@
<li>
<h5>
<a id="pre-aggregate" class="anchor" href="#pre-aggregate" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Pre-Aggregate</h5>
-<p>CarbonData has concept of datamaps to assist in pruning of data while querying so that performance is faster.Pre Aggregate tables are kind of datamaps which can improve the query performance by order of magnitude.CarbonData will automatically pre-aggregae the incremental data and re-write the query to automatically fetch from the most appropriate pre-aggregate table to serve the query faster.</p>
+<p>CarbonData has concept of datamaps to assist in pruning of data while querying so that performance is faster.Pre Aggregate tables are kind of datamaps which can improve the query performance by order of magnitude.CarbonData will automatically pre-aggregate the incremental data and re-write the query to automatically fetch from the most appropriate pre-aggregate table to serve the query faster.</p>
</li>
<li>
<h5>
<a id="time-series" class="anchor" href="#time-series" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Time Series</h5>
-<p>CarbonData has built in understanding of time order(Year, month,day,hour, minute,second).Time series is a pre-aggregate table which can automatically roll-up the data to the desired level during incremental load and serve the query from the most appropriate pre-aggregate table.</p>
+<p>CarbonData has built in understanding of time order(Year, month,day,hour, minute,second). Time series is a pre-aggregate table which can automatically roll-up the data to the desired level during incremental load and serve the query from the most appropriate pre-aggregate table.</p>
</li>
<li>
<h5>
@@ -297,7 +303,7 @@
<li>
<h5>
<a id="mv-materialized-views" class="anchor" href="#mv-materialized-views" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>MV (Materialized Views)</h5>
-<p>MVs are kind of pre-aggregate tables which can support efficent query re-write and processing.CarbonData provides MV which can rewrite query to fetch from any table(including non-carbondata tables).Typical usecase is to store the aggregated data of a non-carbondata fact table into carbondata and use mv to rewrite the query to fetch from carbondata.</p>
+<p>MVs are kind of pre-aggregate tables which can support efficent query re-write and processing.CarbonData provides MV which can rewrite query to fetch from any table(including non-carbondata tables). Typical usecase is to store the aggregated data of a non-carbondata fact table into carbondata and use mv to rewrite the query to fetch from carbondata.</p>
</li>
</ul>
<h3>
@@ -315,12 +321,12 @@
<li>
<h5>
<a id="carbondata-writer" class="anchor" href="#carbondata-writer" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>CarbonData writer</h5>
-<p>CarbonData supports writing data from non-spark application using SDK.Users can use SDK to generate carbondata files from custom applications.Typical usecase is to write the streaming application plugged in to kafka and use carbondata as sink(target) table for storing.</p>
+<p>CarbonData supports writing data from non-spark application using SDK.Users can use SDK to generate carbondata files from custom applications. Typical usecase is to write the streaming application plugged in to kafka and use carbondata as sink(target) table for storing.</p>
</li>
<li>
<h5>
<a id="carbondata-reader" class="anchor" href="#carbondata-reader" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>CarbonData reader</h5>
-<p>CarbonData supports reading of data from non-spark application using SDK.Users can use the SDK to read the carbondata files from their application and do custom processing.</p>
+<p>CarbonData supports reading of data from non-spark application using SDK. Users can use the SDK to read the carbondata files from their application and do custom processing.</p>
</li>
</ul>
<h3>
@@ -329,7 +335,7 @@
<li>
<h5>
<a id="s3" class="anchor" href="#s3" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>S3</h5>
-<p>CarbonData can write to S3, OBS or any cloud storage confirming to S3 protocol.CarbonData uses the HDFS api to write to cloud object stores.</p>
+<p>CarbonData can write to S3, OBS or any cloud storage confirming to S3 protocol. CarbonData uses the HDFS api to write to cloud object stores.</p>
</li>
<li>
<h5>
http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6ad7599a/src/main/webapp/language-manual.html
----------------------------------------------------------------------
diff --git a/src/main/webapp/language-manual.html b/src/main/webapp/language-manual.html
index a0ea674..74c18f4 100644
--- a/src/main/webapp/language-manual.html
+++ b/src/main/webapp/language-manual.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>
@@ -236,11 +244,12 @@
<li>Data Manipulation Statements
<ul>
<li>
-<a href="./dml-of-carbondata.html">DML:</a> <a href="./dml-of-carbondata.html#load-data">Load</a>, <a href="./ddl-of-carbondata.html#insert-overwrite">Insert</a>, <a href="./dml-of-carbondata.html#update">Update</a>, <a href="./dml-of-carbondata.html#delete">Delete</a>
+<a href="./dml-of-carbondata.html">DML:</a> <a href="./dml-of-carbondata.html#load-data">Load</a>, <a href="./dml-of-carbondata.html#insert-data-into-carbondata-table">Insert</a>, <a href="./dml-of-carbondata.html#update">Update</a>, <a href="./dml-of-carbondata.html#delete">Delete</a>
</li>
<li><a href="./segment-management-on-carbondata.html">Segment Management</a></li>
</ul>
</li>
+<li><a href="./carbon-as-spark-datasource-guide.html">CarbonData as Spark's Datasource</a></li>
<li><a href="./configuration-parameters.html">Configuration Properties</a></li>
</ul>
<script>
http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6ad7599a/src/main/webapp/lucene-datamap-guide.html
----------------------------------------------------------------------
diff --git a/src/main/webapp/lucene-datamap-guide.html b/src/main/webapp/lucene-datamap-guide.html
index b8164a2..357286a 100644
--- a/src/main/webapp/lucene-datamap-guide.html
+++ b/src/main/webapp/lucene-datamap-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>
@@ -239,7 +247,7 @@ ON TABLE main_table
<h2>
<a id="lucene-datamap-introduction" class="anchor" href="#lucene-datamap-introduction" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Lucene DataMap Introduction</h2>
<p>Lucene is a high performance, full featured text search engine. Lucene is integrated to carbon as
-an index datamap and managed along with main tables by CarbonData.User can create lucene datamap
+an index datamap and managed along with main tables by CarbonData. User can create lucene datamap
to improve query performance on string columns which has content of more length. So, user can
search tokenized word or pattern of it using lucene query on text content.</p>
<p>For instance, main table called <strong>datamap_test</strong> which is defined as:</p>
@@ -281,7 +289,7 @@ value is compression, the index file size will be compressed.</p>
Queries are to be made on main table. when a query with TEXT_MATCH('name:c10') or
TEXT_MATCH_WITH_LIMIT('name:n10',10)[the second parameter represents the number of result to be
returned, if user does not specify this value, all results will be returned without any limit] is
-fired, two jobs are fired.The first job writes the temporary files in folder created at table level
+fired, two jobs are fired. The first job writes the temporary files in folder created at table level
which contains lucene's seach results and these files will be read in second job to give faster
results. These temporary files will be cleared once the query finishes.</p>
<p>User can verify whether a query can leverage Lucene datamap or not by executing <code>EXPLAIN</code>
http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6ad7599a/src/main/webapp/performance-tuning.html
----------------------------------------------------------------------
diff --git a/src/main/webapp/performance-tuning.html b/src/main/webapp/performance-tuning.html
index 480911c..c63462f 100644
--- a/src/main/webapp/performance-tuning.html
+++ b/src/main/webapp/performance-tuning.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>
@@ -381,7 +389,7 @@ You can configure CarbonData by tuning following properties in carbon.properties
<tbody>
<tr>
<td>carbon.number.of.cores.while.loading</td>
-<td>Default: 2.This value should be >= 2</td>
+<td>Default: 2. This value should be >= 2</td>
<td>Specifies the number of cores used for data processing during data loading in CarbonData.</td>
</tr>
<tr>
@@ -447,7 +455,7 @@ scenarios. After the completion of POC, some of the configurations impacting the
<td>spark/carbonlib/carbon.properties</td>
<td>Data loading and Querying</td>
<td>For minor compaction, specifies the number of segments to be merged in stage 1 and number of compacted segments to be merged in stage 2.</td>
-<td>Each CarbonData load will create one segment, if every load is small in size it will generate many small file over a period of time impacting the query performance. Configuring this parameter will merge the small segment to one big segment which will sort the data and improve the performance. For Example in one telecommunication scenario, the performance improves about 2 times after minor compaction.</td>
+<td>Each CarbonData load will create one segment, if every load is small in size it will generate many small files over a period of time impacting the query performance. Configuring this parameter will merge the small segment to one big segment which will sort the data and improve the performance. For Example in one telecommunication scenario, the performance improves about 2 times after minor compaction.</td>
</tr>
<tr>
<td>spark.sql.shuffle.partitions</td>
@@ -489,21 +497,21 @@ scenarios. After the completion of POC, some of the configurations impacting the
<td>spark/carbonlib/carbon.properties</td>
<td>Data loading</td>
<td>Specify the name of compressor to compress the intermediate sort temporary files during sort procedure in data loading.</td>
-<td>The optional values are 'SNAPPY','GZIP','BZIP2','LZ4','ZSTD' and empty. By default, empty means that Carbondata will not compress the sort temp files. This parameter will be useful if you encounter disk bottleneck.</td>
+<td>The optional values are 'SNAPPY','GZIP','BZIP2','LZ4','ZSTD', and empty. By default, empty means that Carbondata will not compress the sort temp files. This parameter will be useful if you encounter disk bottleneck.</td>
</tr>
<tr>
<td>carbon.load.skewedDataOptimization.enabled</td>
<td>spark/carbonlib/carbon.properties</td>
<td>Data loading</td>
<td>Whether to enable size based block allocation strategy for data loading.</td>
-<td>When loading, carbondata will use file size based block allocation strategy for task distribution. It will make sure that all the executors process the same size of data -- It's useful if the size of your input data files varies widely, say 1MB~1GB.</td>
+<td>When loading, carbondata will use file size based block allocation strategy for task distribution. It will make sure that all the executors process the same size of data -- It's useful if the size of your input data files varies widely, say 1MB to 1GB.</td>
</tr>
<tr>
<td>carbon.load.min.size.enabled</td>
<td>spark/carbonlib/carbon.properties</td>
<td>Data loading</td>
<td>Whether to enable node minumun input data size allocation strategy for data loading.</td>
-<td>When loading, carbondata will use node minumun input data size allocation strategy for task distribution. It will make sure the node load the minimum amount of data -- It's useful if the size of your input data files very small, say 1MB~256MB,Avoid generating a large number of small files.</td>
+<td>When loading, carbondata will use node minumun input data size allocation strategy for task distribution. It will make sure the nodes load the minimum amount of data -- It's useful if the size of your input data files very small, say 1MB to 256MB,Avoid generating a large number of small files.</td>
</tr>
</tbody>
</table>
http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6ad7599a/src/main/webapp/preaggregate-datamap-guide.html
----------------------------------------------------------------------
diff --git a/src/main/webapp/preaggregate-datamap-guide.html b/src/main/webapp/preaggregate-datamap-guide.html
index 6b0783e..c3d4a85 100644
--- a/src/main/webapp/preaggregate-datamap-guide.html
+++ b/src/main/webapp/preaggregate-datamap-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>
@@ -444,7 +452,7 @@ pre-aggregate tables. To further improve the query performance, compaction on pr
can be triggered to merge the segments and files in the pre-aggregate tables.</p>
<h2>
<a id="data-management-with-pre-aggregate-tables" class="anchor" href="#data-management-with-pre-aggregate-tables" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Data Management with pre-aggregate tables</h2>
-<p>In current implementation, data consistence need to be maintained for both main table and pre-aggregate
+<p>In current implementation, data consistency needs to be maintained for both main table and pre-aggregate
tables. Once there is pre-aggregate table created on the main table, following command on the main
table
is not supported:</p>
[18/20] carbondata-site git commit: Updated changes for 1.5.0 release
Posted by ch...@apache.org.
http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6f8949f1/content/installation-guide.html
----------------------------------------------------------------------
diff --git a/content/installation-guide.html b/content/installation-guide.html
new file mode 100644
index 0000000..2e7fab6
--- /dev/null
+++ b/content/installation-guide.html
@@ -0,0 +1,455 @@
+<!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.4.1/"
+ target="_blank">Apache CarbonData 1.4.1</a></li>
+ <li>
+ <a href="https://dist.apache.org/repos/dist/release/carbondata/1.4.0/"
+ target="_blank">Apache CarbonData 1.4.0</a></li>
+ <li>
+ <a href="https://dist.apache.org/repos/dist/release/carbondata/1.3.1/"
+ target="_blank">Apache CarbonData 1.3.1</a></li>
+ <li>
+ <a href="https://dist.apache.org/repos/dist/release/carbondata/1.3.0/"
+ target="_blank">Apache CarbonData 1.3.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="installation-guide" class="anchor" href="#installation-guide" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Installation Guide</h1>
+<p>This tutorial guides you through the installation and configuration of CarbonData in the following two modes :</p>
+<ul>
+<li><a href="#installing-and-configuring-carbondata-on-standalone-spark-cluster">Installing and Configuring CarbonData on Standalone Spark Cluster</a></li>
+<li><a href="#installing-and-configuring-carbondata-on-spark-on-yarn-cluster">Installing and Configuring CarbonData on Spark on YARN Cluster</a></li>
+</ul>
+<p>followed by :</p>
+<ul>
+<li><a href="#query-execution-using-carbondata-thrift-server">Query Execution using CarbonData Thrift Server</a></li>
+</ul>
+<h2>
+<a id="installing-and-configuring-carbondata-on-standalone-spark-cluster" class="anchor" href="#installing-and-configuring-carbondata-on-standalone-spark-cluster" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Installing and Configuring CarbonData on Standalone Spark Cluster</h2>
+<h3>
+<a id="prerequisites" class="anchor" href="#prerequisites" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Prerequisites</h3>
+<ul>
+<li>
+<p>Hadoop HDFS and Yarn should be installed and running.</p>
+</li>
+<li>
+<p>Spark should be installed and running on all the cluster nodes.</p>
+</li>
+<li>
+<p>CarbonData user should have permission to access HDFS.</p>
+</li>
+</ul>
+<h3>
+<a id="procedure" class="anchor" href="#procedure" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Procedure</h3>
+<ol>
+<li>
+<p><a href="https://github.com/apache/carbondata/blob/master/build/README.md" target=_blank>Build the CarbonData</a> project and get the assembly jar from <code>./assembly/target/scala-2.1x/carbondata_xxx.jar</code>.</p>
+</li>
+<li>
+<p>Copy <code>./assembly/target/scala-2.1x/carbondata_xxx.jar</code> to <code>$SPARK_HOME/carbonlib</code> folder.</p>
+<p><strong>NOTE</strong>: Create the carbonlib folder if it does not exist inside <code>$SPARK_HOME</code> path.</p>
+</li>
+<li>
+<p>Add the carbonlib folder path in the Spark classpath. (Edit <code>$SPARK_HOME/conf/spark-env.sh</code> file and modify the value of <code>SPARK_CLASSPATH</code> by appending <code>$SPARK_HOME/carbonlib/*</code> to the existing value)</p>
+</li>
+<li>
+<p>Copy the <code>./conf/carbon.properties.template</code> file from CarbonData repository to <code>$SPARK_HOME/conf/</code> folder and rename the file to <code>carbon.properties</code>.</p>
+</li>
+<li>
+<p>Repeat Step 2 to Step 5 in all the nodes of the cluster.</p>
+</li>
+<li>
+<p>In Spark node[master], configure the properties mentioned in the following table in <code>$SPARK_HOME/conf/spark-defaults.conf</code> file.</p>
+</li>
+</ol>
+<table>
+<thead>
+<tr>
+<th>Property</th>
+<th>Value</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>spark.driver.extraJavaOptions</td>
+<td><code>-Dcarbon.properties.filepath = $SPARK_HOME/conf/carbon.properties</code></td>
+<td>A string of extra JVM options to pass to the driver. For instance, GC settings or other logging.</td>
+</tr>
+<tr>
+<td>spark.executor.extraJavaOptions</td>
+<td><code>-Dcarbon.properties.filepath = $SPARK_HOME/conf/carbon.properties</code></td>
+<td>A string of extra JVM options to pass to executors. For instance, GC settings or other logging. <strong>NOTE</strong>: You can enter multiple values separated by space.</td>
+</tr>
+</tbody>
+</table>
+<ol start="7">
+<li>Add the following properties in <code>$SPARK_HOME/conf/carbon.properties</code> file:</li>
+</ol>
+<table>
+<thead>
+<tr>
+<th>Property</th>
+<th>Required</th>
+<th>Description</th>
+<th>Example</th>
+<th>Remark</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>carbon.storelocation</td>
+<td>NO</td>
+<td>Location where data CarbonData will create the store and write the data in its own format. If not specified then it takes spark.sql.warehouse.dir path.</td>
+<td>hdfs://HOSTNAME:PORT/Opt/CarbonStore</td>
+<td>Propose to set HDFS directory</td>
+</tr>
+</tbody>
+</table>
+<ol start="8">
+<li>Verify the installation. For example:</li>
+</ol>
+<pre><code>./spark-shell --master spark://HOSTNAME:PORT --total-executor-cores 2
+--executor-memory 2G
+</code></pre>
+<p><strong>NOTE</strong>: Make sure you have permissions for CarbonData JARs and files through which driver and executor will start.</p>
+<p>To get started with CarbonData : <a href="quick-start-guide.html">Quick Start</a>, <a href="data-management-on-carbondata.html">Data Management on CarbonData</a></p>
+<h2>
+<a id="installing-and-configuring-carbondata-on-spark-on-yarn-cluster" class="anchor" href="#installing-and-configuring-carbondata-on-spark-on-yarn-cluster" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Installing and Configuring CarbonData on Spark on YARN Cluster</h2>
+<p>This section provides the procedure to install CarbonData on "Spark on YARN" cluster.</p>
+<h3>
+<a id="prerequisites-1" class="anchor" href="#prerequisites-1" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Prerequisites</h3>
+<ul>
+<li>Hadoop HDFS and Yarn should be installed and running.</li>
+<li>Spark should be installed and running in all the clients.</li>
+<li>CarbonData user should have permission to access HDFS.</li>
+</ul>
+<h3>
+<a id="procedure-1" class="anchor" href="#procedure-1" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Procedure</h3>
+<p>The following steps are only for Driver Nodes. (Driver nodes are the one which starts the spark context.)</p>
+<ol>
+<li>
+<p><a href="https://github.com/apache/carbondata/blob/master/build/README.md" target=_blank>Build the CarbonData</a> project and get the assembly jar from <code>./assembly/target/scala-2.1x/carbondata_xxx.jar</code> and copy to <code>$SPARK_HOME/carbonlib</code> folder.</p>
+<p><strong>NOTE</strong>: Create the carbonlib folder if it does not exists inside <code>$SPARK_HOME</code> path.</p>
+</li>
+<li>
+<p>Copy the <code>./conf/carbon.properties.template</code> file from CarbonData repository to <code>$SPARK_HOME/conf/</code> folder and rename the file to <code>carbon.properties</code>.</p>
+</li>
+<li>
+<p>Create <code>tar.gz</code> file of carbonlib folder and move it inside the carbonlib folder.</p>
+</li>
+</ol>
+<pre><code>cd $SPARK_HOME
+tar -zcvf carbondata.tar.gz carbonlib/
+mv carbondata.tar.gz carbonlib/
+</code></pre>
+<ol start="4">
+<li>Configure the properties mentioned in the following table in <code>$SPARK_HOME/conf/spark-defaults.conf</code> file.</li>
+</ol>
+<table>
+<thead>
+<tr>
+<th>Property</th>
+<th>Description</th>
+<th>Value</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>spark.master</td>
+<td>Set this value to run the Spark in yarn cluster mode.</td>
+<td>Set yarn-client to run the Spark in yarn cluster mode.</td>
+</tr>
+<tr>
+<td>spark.yarn.dist.files</td>
+<td>Comma-separated list of files to be placed in the working directory of each executor.</td>
+<td><code>$SPARK_HOME/conf/carbon.properties</code></td>
+</tr>
+<tr>
+<td>spark.yarn.dist.archives</td>
+<td>Comma-separated list of archives to be extracted into the working directory of each executor.</td>
+<td><code>$SPARK_HOME/carbonlib/carbondata.tar.gz</code></td>
+</tr>
+<tr>
+<td>spark.executor.extraJavaOptions</td>
+<td>A string of extra JVM options to pass to executors. For instance <strong>NOTE</strong>: You can enter multiple values separated by space.</td>
+<td><code>-Dcarbon.properties.filepath = carbon.properties</code></td>
+</tr>
+<tr>
+<td>spark.executor.extraClassPath</td>
+<td>Extra classpath entries to prepend to the classpath of executors. <strong>NOTE</strong>: If SPARK_CLASSPATH is defined in spark-env.sh, then comment it and append the values in below parameter spark.driver.extraClassPath</td>
+<td><code>carbondata.tar.gz/carbonlib/*</code></td>
+</tr>
+<tr>
+<td>spark.driver.extraClassPath</td>
+<td>Extra classpath entries to prepend to the classpath of the driver. <strong>NOTE</strong>: If SPARK_CLASSPATH is defined in spark-env.sh, then comment it and append the value in below parameter spark.driver.extraClassPath.</td>
+<td><code>$SPARK_HOME/carbonlib/*</code></td>
+</tr>
+<tr>
+<td>spark.driver.extraJavaOptions</td>
+<td>A string of extra JVM options to pass to the driver. For instance, GC settings or other logging.</td>
+<td><code>-Dcarbon.properties.filepath = $SPARK_HOME/conf/carbon.properties</code></td>
+</tr>
+</tbody>
+</table>
+<ol start="5">
+<li>Add the following properties in <code>$SPARK_HOME/conf/carbon.properties</code>:</li>
+</ol>
+<table>
+<thead>
+<tr>
+<th>Property</th>
+<th>Required</th>
+<th>Description</th>
+<th>Example</th>
+<th>Default Value</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>carbon.storelocation</td>
+<td>NO</td>
+<td>Location where CarbonData will create the store and write the data in its own format. If not specified then it takes spark.sql.warehouse.dir path.</td>
+<td>hdfs://HOSTNAME:PORT/Opt/CarbonStore</td>
+<td>Propose to set HDFS directory</td>
+</tr>
+</tbody>
+</table>
+<ol start="6">
+<li>Verify the installation.</li>
+</ol>
+<pre><code> ./bin/spark-shell --master yarn-client --driver-memory 1g
+ --executor-cores 2 --executor-memory 2G
+</code></pre>
+<p><strong>NOTE</strong>: Make sure you have permissions for CarbonData JARs and files through which driver and executor will start.</p>
+<p>Getting started with CarbonData : <a href="quick-start-guide.html">Quick Start</a>, <a href="data-management-on-carbondata.html">Data Management on CarbonData</a></p>
+<h2>
+<a id="query-execution-using-carbondata-thrift-server" class="anchor" href="#query-execution-using-carbondata-thrift-server" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Query Execution Using CarbonData Thrift Server</h2>
+<h3>
+<a id="starting-carbondata-thrift-server" class="anchor" href="#starting-carbondata-thrift-server" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Starting CarbonData Thrift Server.</h3>
+<p>a. cd <code>$SPARK_HOME</code></p>
+<p>b. Run the following command to start the CarbonData thrift server.</p>
+<pre><code>./bin/spark-submit
+--class org.apache.carbondata.spark.thriftserver.CarbonThriftServer
+$SPARK_HOME/carbonlib/$CARBON_ASSEMBLY_JAR <carbon_store_path>
+</code></pre>
+<table>
+<thead>
+<tr>
+<th>Parameter</th>
+<th>Description</th>
+<th>Example</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>CARBON_ASSEMBLY_JAR</td>
+<td>CarbonData assembly jar name present in the <code>$SPARK_HOME/carbonlib/</code> folder.</td>
+<td>carbondata_2.xx-x.x.x-SNAPSHOT-shade-hadoop2.7.2.jar</td>
+</tr>
+<tr>
+<td>carbon_store_path</td>
+<td>This is a parameter to the CarbonThriftServer class. This a HDFS path where CarbonData files will be kept. Strongly Recommended to put same as carbon.storelocation parameter of carbon.properties. If not specified then it takes spark.sql.warehouse.dir path.</td>
+<td><code>hdfs://<host_name>:port/user/hive/warehouse/carbon.store</code></td>
+</tr>
+</tbody>
+</table>
+<p><strong>NOTE</strong>: From Spark 1.6, by default the Thrift server runs in multi-session mode. Which means each JDBC/ODBC connection owns a copy of their own SQL configuration and temporary function registry. Cached tables are still shared though. If you prefer to run the Thrift server in single-session mode and share all SQL configuration and temporary function registry, please set option <code>spark.sql.hive.thriftServer.singleSession</code> to <code>true</code>. You may either add this option to <code>spark-defaults.conf</code>, or pass it to <code>spark-submit.sh</code> via <code>--conf</code>:</p>
+<pre><code>./bin/spark-submit
+--conf spark.sql.hive.thriftServer.singleSession=true
+--class org.apache.carbondata.spark.thriftserver.CarbonThriftServer
+$SPARK_HOME/carbonlib/$CARBON_ASSEMBLY_JAR <carbon_store_path>
+</code></pre>
+<p><strong>But</strong> in single-session mode, if one user changes the database from one connection, the database of the other connections will be changed too.</p>
+<p><strong>Examples</strong></p>
+<ul>
+<li>Start with default memory and executors.</li>
+</ul>
+<pre><code>./bin/spark-submit
+--class org.apache.carbondata.spark.thriftserver.CarbonThriftServer
+$SPARK_HOME/carbonlib
+/carbondata_2.xx-x.x.x-SNAPSHOT-shade-hadoop2.7.2.jar
+hdfs://<host_name>:port/user/hive/warehouse/carbon.store
+</code></pre>
+<ul>
+<li>Start with Fixed executors and resources.</li>
+</ul>
+<pre><code>./bin/spark-submit
+--class org.apache.carbondata.spark.thriftserver.CarbonThriftServer
+--num-executors 3 --driver-memory 20g --executor-memory 250g
+--executor-cores 32
+/srv/OSCON/BigData/HACluster/install/spark/sparkJdbc/lib
+/carbondata_2.xx-x.x.x-SNAPSHOT-shade-hadoop2.7.2.jar
+hdfs://<host_name>:port/user/hive/warehouse/carbon.store
+</code></pre>
+<h3>
+<a id="connecting-to-carbondata-thrift-server-using-beeline" class="anchor" href="#connecting-to-carbondata-thrift-server-using-beeline" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Connecting to CarbonData Thrift Server Using Beeline.</h3>
+<pre><code> cd $SPARK_HOME
+ ./sbin/start-thriftserver.sh
+ ./bin/beeline -u jdbc:hive2://<thriftserver_host>:port
+
+ Example
+ ./bin/beeline -u jdbc:hive2://10.10.10.10:10000
+</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/6f8949f1/content/mainpage.html
----------------------------------------------------------------------
diff --git a/content/mainpage.html b/content/mainpage.html
new file mode 100644
index 0000000..d515853
--- /dev/null
+++ b/content/mainpage.html
@@ -0,0 +1,214 @@
+<!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.4.1/"
+ target="_blank">Apache CarbonData 1.4.1</a></li>
+ <li>
+ <a href="https://dist.apache.org/repos/dist/release/carbondata/1.4.0/"
+ target="_blank">Apache CarbonData 1.4.0</a></li>
+ <li>
+ <a href="https://dist.apache.org/repos/dist/release/carbondata/1.3.1/"
+ target="_blank">Apache CarbonData 1.3.1</a></li>
+ <li>
+ <a href="https://dist.apache.org/repos/dist/release/carbondata/1.3.0/"
+ target="_blank">Apache CarbonData 1.3.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">
+ <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="doc-heading">
+ <h4 class="title">Documentation
+ <span class="title-underline"></span>
+ </h4>
+ </div>
+
+ <div class="row">
+
+ <div class="col-sm-12 col-md-12">
+ <span class="text-justify">
+ Welcome to Apache CarbonData. 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. This user guide provides a detailed description about the CarbonData and its features.
+ Let's get started !
+ </span>
+ <hr style="margin: 12px 0 8px">
+ <div>
+ <ul class="sub-nav">
+ <li><a href="quick-start-guide.html">Quick Start</a></li>
+ <li><a href="file-structure-of-carbondata.html">CarbonData File Structure</a></li>
+ <li><a href="supported-data-types-in-carbondata.html">Data Types</a></li>
+ <li><a href="data-management-on-carbondata.html">Data Management On CarbonData</a></li>
+ <li><a href="installation-guide.html">Installation Guide</a></li>
+ <li><a href="configuration-parameters.html">Configuring CarbonData</a></li>
+ <li><a href="streaming-guide.html">Streaming Guide</a></li>
+ <li><a href="sdk-guide.html">SDK Guide</a></li>
+ <li><a href="s3-guide.html">S3 Guide (Alpha Feature)</a></li>
+ <li><a href="datamap-developer-guide.html">DataMap Developer Guide</a></li>
+ <li><a href="datamap-management.html">CarbonData DataMap Management</a></li>
+ <li><a href="bloomfilter-datamap-guide.html">CarbonData BloomFilter DataMap (Alpha Feature)</a></li>
+ <li><a href="lucene-datamap-guide.html">CarbonData Lucene DataMap (Alpha Feature)</a></li>
+ <li><a href="preaggregate-datamap-guide.html">CarbonData Pre-aggregate DataMap</a></li>
+ <li><a href="timeseries-datamap-guide.html">CarbonData Timeseries DataMap</a></li>
+ <li><a href="faq.html">FAQs</a></li>
+ <li><a href="troubleshooting.html">Troubleshooting</a></li>
+ <li><a href="useful-tips-on-carbondata.html">Useful Tips</a></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 -->
+</div>
+</div>
+</div>
+</section><!-- End systemblock part -->
+<script src="js/custom.js"></script>
+</body>
+</html>
http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6f8949f1/content/sdk-writer-guide.html
----------------------------------------------------------------------
diff --git a/content/sdk-writer-guide.html b/content/sdk-writer-guide.html
new file mode 100644
index 0000000..36bb9ad
--- /dev/null
+++ b/content/sdk-writer-guide.html
@@ -0,0 +1,549 @@
+<!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.4.0/"
+ target="_blank">Apache CarbonData 1.4.0</a></li>
+ <li>
+ <a href="https://dist.apache.org/repos/dist/release/carbondata/1.3.1/"
+ target="_blank">Apache CarbonData 1.3.1</a></li>
+ <li>
+ <a href="https://dist.apache.org/repos/dist/release/carbondata/1.3.0/"
+ target="_blank">Apache CarbonData 1.3.0</a></li>
+ <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="sdk-writer-guide" class="anchor" href="#sdk-writer-guide" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>SDK Writer Guide</h1>
+<p>In the carbon jars package, there exist a carbondata-store-sdk-x.x.x-SNAPSHOT.jar.
+This SDK writer, writes carbondata file and carbonindex file at a given path.
+External client can make use of this writer to convert other format data or live data to create carbondata and index files.
+These SDK writer output contains just a carbondata and carbonindex files. No metadata folder will be present.</p>
+<h2>
+<a id="quick-example" class="anchor" href="#quick-example" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Quick example</h2>
+<h3>
+<a id="example-with-csv-format" class="anchor" href="#example-with-csv-format" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Example with csv format</h3>
+<div class="highlight highlight-source-java"><pre> <span class="pl-k">import</span> <span class="pl-smi">java.io.IOException</span>;
+
+ <span class="pl-k">import</span> <span class="pl-smi">org.apache.carbondata.common.exceptions.sql.InvalidLoadOptionException</span>;
+ <span class="pl-k">import</span> <span class="pl-smi">org.apache.carbondata.core.metadata.datatype.DataTypes</span>;
+ <span class="pl-k">import</span> <span class="pl-smi">org.apache.carbondata.sdk.file.CarbonWriter</span>;
+ <span class="pl-k">import</span> <span class="pl-smi">org.apache.carbondata.sdk.file.CarbonWriterBuilder</span>;
+ <span class="pl-k">import</span> <span class="pl-smi">org.apache.carbondata.sdk.file.Field</span>;
+ <span class="pl-k">import</span> <span class="pl-smi">org.apache.carbondata.sdk.file.Schema</span>;
+
+ <span class="pl-k">public</span> <span class="pl-k">class</span> <span class="pl-en">TestSdk</span> {
+
+ <span class="pl-k">public</span> <span class="pl-k">static</span> <span class="pl-k">void</span> <span class="pl-en">main</span>(<span class="pl-k">String</span>[] <span class="pl-v">args</span>) <span class="pl-k">throws</span> <span class="pl-smi">IOException</span>, <span class="pl-smi">InvalidLoadOptionException</span> {
+ testSdkWriter();
+ }
+
+ <span class="pl-k">public</span> <span class="pl-k">static</span> <span class="pl-k">void</span> <span class="pl-en">testSdkWriter</span>() <span class="pl-k">throws</span> <span class="pl-smi">IOException</span>, <span class="pl-smi">InvalidLoadOptionException</span> {
+ <span class="pl-smi">String</span> path <span class="pl-k">=</span> <span class="pl-s"><span class="pl-pds">"</span>/home/root1/Documents/ab/temp<span class="pl-pds">"</span></span>;
+
+ <span class="pl-k">Field</span>[] fields <span class="pl-k">=</span> <span class="pl-k">new</span> <span class="pl-smi">Field</span>[<span class="pl-c1">2</span>];
+ fields[<span class="pl-c1">0</span>] <span class="pl-k">=</span> <span class="pl-k">new</span> <span class="pl-smi">Field</span>(<span class="pl-s"><span class="pl-pds">"</span>name<span class="pl-pds">"</span></span>, <span class="pl-smi">DataTypes</span><span class="pl-c1"><span class="pl-k">.</span>STRING</span>);
+ fields[<span class="pl-c1">1</span>] <span class="pl-k">=</span> <span class="pl-k">new</span> <span class="pl-smi">Field</span>(<span class="pl-s"><span class="pl-pds">"</span>age<span class="pl-pds">"</span></span>, <span class="pl-smi">DataTypes</span><span class="pl-c1"><span class="pl-k">.</span>INT</span>);
+
+ <span class="pl-smi">Schema</span> schema <span class="pl-k">=</span> <span class="pl-k">new</span> <span class="pl-smi">Schema</span>(fields);
+
+ <span class="pl-smi">CarbonWriterBuilder</span> builder <span class="pl-k">=</span> <span class="pl-smi">CarbonWriter</span><span class="pl-k">.</span>builder()<span class="pl-k">.</span>withSchema(schema)<span class="pl-k">.</span>outputPath(path);
+
+ <span class="pl-smi">CarbonWriter</span> writer <span class="pl-k">=</span> builder<span class="pl-k">.</span>buildWriterForCSVInput();
+
+ <span class="pl-k">int</span> rows <span class="pl-k">=</span> <span class="pl-c1">5</span>;
+ <span class="pl-k">for</span> (<span class="pl-k">int</span> i <span class="pl-k">=</span> <span class="pl-c1">0</span>; i <span class="pl-k"><</span> rows; i<span class="pl-k">++</span>) {
+ writer<span class="pl-k">.</span>write(<span class="pl-k">new</span> <span class="pl-smi">String</span>[] { <span class="pl-s"><span class="pl-pds">"</span>robot<span class="pl-pds">"</span></span> <span class="pl-k">+</span> (i <span class="pl-k">%</span> <span class="pl-c1">10</span>), <span class="pl-smi">String</span><span class="pl-k">.</span>valueOf(i) });
+ }
+ writer<span class="pl-k">.</span>close();
+ }
+ }</pre></div>
+<h3>
+<a id="example-with-avro-format" class="anchor" href="#example-with-avro-format" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Example with Avro format</h3>
+<div class="highlight highlight-source-java"><pre><span class="pl-k">import</span> <span class="pl-smi">java.io.IOException</span>;
+
+<span class="pl-k">import</span> <span class="pl-smi">org.apache.carbondata.common.exceptions.sql.InvalidLoadOptionException</span>;
+<span class="pl-k">import</span> <span class="pl-smi">org.apache.carbondata.core.metadata.datatype.DataTypes</span>;
+<span class="pl-k">import</span> <span class="pl-smi">org.apache.carbondata.sdk.file.AvroCarbonWriter</span>;
+<span class="pl-k">import</span> <span class="pl-smi">org.apache.carbondata.sdk.file.CarbonWriter</span>;
+<span class="pl-k">import</span> <span class="pl-smi">org.apache.carbondata.sdk.file.Field</span>;
+
+<span class="pl-k">import</span> <span class="pl-smi">org.apache.avro.generic.GenericData</span>;
+<span class="pl-k">import</span> <span class="pl-smi">org.apache.commons.lang.CharEncoding</span>;
+
+<span class="pl-k">import</span> <span class="pl-smi">tech.allegro.schema.json2avro.converter.JsonAvroConverter</span>;
+
+<span class="pl-k">public</span> <span class="pl-k">class</span> <span class="pl-en">TestSdkAvro</span> {
+
+ <span class="pl-k">public</span> <span class="pl-k">static</span> <span class="pl-k">void</span> <span class="pl-en">main</span>(<span class="pl-k">String</span>[] <span class="pl-v">args</span>) <span class="pl-k">throws</span> <span class="pl-smi">IOException</span>, <span class="pl-smi">InvalidLoadOptionException</span> {
+ testSdkWriter();
+ }
+
+
+ <span class="pl-k">public</span> <span class="pl-k">static</span> <span class="pl-k">void</span> <span class="pl-en">testSdkWriter</span>() <span class="pl-k">throws</span> <span class="pl-smi">IOException</span>, <span class="pl-smi">InvalidLoadOptionException</span> {
+ <span class="pl-smi">String</span> path <span class="pl-k">=</span> <span class="pl-s"><span class="pl-pds">"</span>./AvroCarbonWriterSuiteWriteFiles<span class="pl-pds">"</span></span>;
+ <span class="pl-c"><span class="pl-c">//</span> Avro schema</span>
+ <span class="pl-smi">String</span> avroSchema <span class="pl-k">=</span>
+ <span class="pl-s"><span class="pl-pds">"</span>{<span class="pl-pds">"</span></span> <span class="pl-k">+</span>
+ <span class="pl-s"><span class="pl-pds">"</span> <span class="pl-cce">\"</span>type<span class="pl-cce">\"</span> : <span class="pl-cce">\"</span>record<span class="pl-cce">\"</span>,<span class="pl-pds">"</span></span> <span class="pl-k">+</span>
+ <span class="pl-s"><span class="pl-pds">"</span> <span class="pl-cce">\"</span>name<span class="pl-cce">\"</span> : <span class="pl-cce">\"</span>Acme<span class="pl-cce">\"</span>,<span class="pl-pds">"</span></span> <span class="pl-k">+</span>
+ <span class="pl-s"><span class="pl-pds">"</span> <span class="pl-cce">\"</span>fields<span class="pl-cce">\"</span> : [<span class="pl-pds">"</span></span>
+ <span class="pl-k">+</span> <span class="pl-s"><span class="pl-pds">"</span>{ <span class="pl-cce">\"</span>name<span class="pl-cce">\"</span> : <span class="pl-cce">\"</span>fname<span class="pl-cce">\"</span>, <span class="pl-cce">\"</span>type<span class="pl-cce">\"</span> : <span class="pl-cce">\"</span>string<span class="pl-cce">\"</span> },<span class="pl-pds">"</span></span>
+ <span class="pl-k">+</span> <span class="pl-s"><span class="pl-pds">"</span>{ <span class="pl-cce">\"</span>name<span class="pl-cce">\"</span> : <span class="pl-cce">\"</span>age<span class="pl-cce">\"</span>, <span class="pl-cce">\"</span>type<span class="pl-cce">\"</span> : <span class="pl-cce">\"</span>int<span class="pl-cce">\"</span> }]<span class="pl-pds">"</span></span> <span class="pl-k">+</span>
+ <span class="pl-s"><span class="pl-pds">"</span>}<span class="pl-pds">"</span></span>;
+
+ <span class="pl-smi">String</span> json <span class="pl-k">=</span> <span class="pl-s"><span class="pl-pds">"</span>{<span class="pl-cce">\"</span>fname<span class="pl-cce">\"</span>:<span class="pl-cce">\"</span>bob<span class="pl-cce">\"</span>, <span class="pl-cce">\"</span>age<span class="pl-cce">\"</span>:10}<span class="pl-pds">"</span></span>;
+
+ <span class="pl-c"><span class="pl-c">//</span> conversion to GenericData.Record</span>
+ <span class="pl-smi">JsonAvroConverter</span> converter <span class="pl-k">=</span> <span class="pl-k">new</span> <span class="pl-smi">JsonAvroConverter</span>();
+ <span class="pl-smi">GenericData</span><span class="pl-k">.</span><span class="pl-smi">Record</span> record <span class="pl-k">=</span> converter<span class="pl-k">.</span>convertToGenericDataRecord(
+ json<span class="pl-k">.</span>getBytes(<span class="pl-smi">CharEncoding</span><span class="pl-c1"><span class="pl-k">.</span>UTF_8</span>), <span class="pl-k">new</span> <span class="pl-smi">org.apache.avro<span class="pl-k">.</span>Schema</span>.<span class="pl-smi">Parser</span>()<span class="pl-k">.</span>parse(avroSchema));
+
+ <span class="pl-c"><span class="pl-c">//</span> prepare carbon schema from avro schema </span>
+ <span class="pl-smi">org.apache.carbondata.sdk.file<span class="pl-k">.</span>Schema</span> carbonSchema <span class="pl-k">=</span>
+ <span class="pl-smi">AvroCarbonWriter</span><span class="pl-k">.</span>getCarbonSchemaFromAvroSchema(avroSchema);
+
+ <span class="pl-k">try</span> {
+ <span class="pl-smi">CarbonWriter</span> writer <span class="pl-k">=</span> <span class="pl-smi">CarbonWriter</span><span class="pl-k">.</span>builder()
+ .withSchema(carbonSchema)
+ .outputPath(path)
+ .buildWriterForAvroInput();
+
+ <span class="pl-k">for</span> (<span class="pl-k">int</span> i <span class="pl-k">=</span> <span class="pl-c1">0</span>; i <span class="pl-k"><</span> <span class="pl-c1">100</span>; i<span class="pl-k">++</span>) {
+ writer<span class="pl-k">.</span>write(record);
+ }
+ writer<span class="pl-k">.</span>close();
+ } <span class="pl-k">catch</span> (<span class="pl-smi">Exception</span> e) {
+ e<span class="pl-k">.</span>printStackTrace();
+ }
+ }
+}</pre></div>
+<h2>
+<a id="datatypes-mapping" class="anchor" href="#datatypes-mapping" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Datatypes Mapping</h2>
+<p>Each of SQL data types are mapped into data types of SDK. Following are the mapping:</p>
+<table>
+<thead>
+<tr>
+<th>SQL DataTypes</th>
+<th>Mapped SDK DataTypes</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>BOOLEAN</td>
+<td>DataTypes.BOOLEAN</td>
+</tr>
+<tr>
+<td>SMALLINT</td>
+<td>DataTypes.SHORT</td>
+</tr>
+<tr>
+<td>INTEGER</td>
+<td>DataTypes.INT</td>
+</tr>
+<tr>
+<td>BIGINT</td>
+<td>DataTypes.LONG</td>
+</tr>
+<tr>
+<td>DOUBLE</td>
+<td>DataTypes.DOUBLE</td>
+</tr>
+<tr>
+<td>VARCHAR</td>
+<td>DataTypes.STRING</td>
+</tr>
+<tr>
+<td>DATE</td>
+<td>DataTypes.DATE</td>
+</tr>
+<tr>
+<td>TIMESTAMP</td>
+<td>DataTypes.TIMESTAMP</td>
+</tr>
+<tr>
+<td>STRING</td>
+<td>DataTypes.STRING</td>
+</tr>
+<tr>
+<td>DECIMAL</td>
+<td>DataTypes.createDecimalType(precision, scale)</td>
+</tr>
+</tbody>
+</table>
+<h2>
+<a id="api-list" class="anchor" href="#api-list" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>API List</h2>
+<h3>
+<a id="class-orgapachecarbondatasdkfilecarbonwriterbuilder" class="anchor" href="#class-orgapachecarbondatasdkfilecarbonwriterbuilder" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Class org.apache.carbondata.sdk.file.CarbonWriterBuilder</h3>
+<pre><code>/**
+* prepares the builder with the schema provided
+* @param schema is instance of Schema
+* This method must be called when building CarbonWriterBuilder
+* @return updated CarbonWriterBuilder
+*/
+public CarbonWriterBuilder withSchema(Schema schema);
+</code></pre>
+<pre><code>/**
+* Sets the output path of the writer builder
+* @param path is the absolute path where output files are written
+* This method must be called when building CarbonWriterBuilder
+* @return updated CarbonWriterBuilder
+*/
+public CarbonWriterBuilder outputPath(String path);
+</code></pre>
+<pre><code>/**
+* If set false, writes the carbondata and carbonindex files in a flat folder structure
+* @param isTransactionalTable is a boolelan value
+* if set to false, then writes the carbondata and carbonindex files
+* in a flat folder structure.
+* if set to true, then writes the carbondata and carbonindex files
+* in segment folder structure..
+* By default set to false.
+* @return updated CarbonWriterBuilder
+*/
+public CarbonWriterBuilder isTransactionalTable(boolean isTransactionalTable);
+</code></pre>
+<pre><code>/**
+* to set the timestamp in the carbondata and carbonindex index files
+* @param UUID is a timestamp to be used in the carbondata and carbonindex index files.
+* By default set to zero.
+* @return updated CarbonWriterBuilder
+*/
+public CarbonWriterBuilder uniqueIdentifier(long UUID);
+</code></pre>
+<pre><code>/**
+* To set the carbondata file size in MB between 1MB-2048MB
+* @param blockSize is size in MB between 1MB to 2048 MB
+* default value is 1024 MB
+* @return updated CarbonWriterBuilder
+*/
+public CarbonWriterBuilder withBlockSize(int blockSize);
+</code></pre>
+<pre><code>/**
+* To set the blocklet size of carbondata file
+* @param blockletSize is blocklet size in MB
+* default value is 64 MB
+* @return updated CarbonWriterBuilder
+*/
+public CarbonWriterBuilder withBlockletSize(int blockletSize);
+</code></pre>
+<pre><code>/**
+* sets the list of columns that needs to be in sorted order
+* @param sortColumns is a string array of columns that needs to be sorted.
+* If it is null or by default all dimensions are selected for sorting
+* If it is empty array, no columns are sorted
+* @return updated CarbonWriterBuilder
+*/
+public CarbonWriterBuilder sortBy(String[] sortColumns);
+</code></pre>
+<pre><code>/**
+* If set, create a schema file in metadata folder.
+* @param persist is a boolean value, If set to true, creates a schema file in metadata folder.
+* By default set to false. will not create metadata folder
+* @return updated CarbonWriterBuilder
+*/
+public CarbonWriterBuilder persistSchemaFile(boolean persist);
+</code></pre>
+<pre><code>/**
+* sets the taskNo for the writer. SDKs concurrently running
+* will set taskNo in order to avoid conflicts in file's name during write.
+* @param taskNo is the TaskNo user wants to specify.
+* by default it is system time in nano seconds.
+* @return updated CarbonWriterBuilder
+*/
+public CarbonWriterBuilder taskNo(String taskNo);
+</code></pre>
+<pre><code>/**
+* To support the load options for sdk writer
+* @param options key,value pair of load options.
+* supported keys values are
+* a. bad_records_logger_enable -- true (write into separate logs), false
+* b. bad_records_action -- FAIL, FORCE, IGNORE, REDIRECT
+* c. bad_record_path -- path
+* d. dateformat -- same as JAVA SimpleDateFormat
+* e. timestampformat -- same as JAVA SimpleDateFormat
+* f. complex_delimiter_level_1 -- value to Split the complexTypeData
+* g. complex_delimiter_level_2 -- value to Split the nested complexTypeData
+* h. quotechar
+* i. escapechar
+*
+* Default values are as follows.
+*
+* a. bad_records_logger_enable -- "false"
+* b. bad_records_action -- "FAIL"
+* c. bad_record_path -- ""
+* d. dateformat -- "" , uses from carbon.properties file
+* e. timestampformat -- "", uses from carbon.properties file
+* f. complex_delimiter_level_1 -- "$"
+* g. complex_delimiter_level_2 -- ":"
+* h. quotechar -- "\""
+* i. escapechar -- "\\"
+*
+* @return updated CarbonWriterBuilder
+*/
+public CarbonWriterBuilder withLoadOptions(Map<String, String> options);
+</code></pre>
+<pre><code>/**
+* Build a {@link CarbonWriter}, which accepts row in CSV format object
+* @return CSVCarbonWriter
+* @throws IOException
+* @throws InvalidLoadOptionException
+*/
+public CarbonWriter buildWriterForCSVInput() throws IOException, InvalidLoadOptionException;
+</code></pre>
+<pre><code>/**
+* Build a {@link CarbonWriter}, which accepts Avro format object
+* @return AvroCarbonWriter
+* @throws IOException
+* @throws InvalidLoadOptionException
+*/
+public CarbonWriter buildWriterForAvroInput() throws IOException, InvalidLoadOptionException;
+</code></pre>
+<h3>
+<a id="class-orgapachecarbondatasdkfilecarbonwriter" class="anchor" href="#class-orgapachecarbondatasdkfilecarbonwriter" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Class org.apache.carbondata.sdk.file.CarbonWriter</h3>
+<pre><code>/**
+* Write an object to the file, the format of the object depends on the implementation
+* If AvroCarbonWriter, object is of type org.apache.avro.generic.GenericData.Record
+* If CSVCarbonWriter, object is of type String[]
+* Note: This API is not thread safe
+* @param object
+* @throws IOException
+*/
+public abstract void write(Object object) throws IOException;
+</code></pre>
+<pre><code>/**
+* Flush and close the writer
+*/
+public abstract void close() throws IOException;
+</code></pre>
+<pre><code>/**
+* Create a {@link CarbonWriterBuilder} to build a {@link CarbonWriter}
+*/
+public static CarbonWriterBuilder builder() {
+return new CarbonWriterBuilder();
+}
+</code></pre>
+<h3>
+<a id="class-orgapachecarbondatasdkfilefield" class="anchor" href="#class-orgapachecarbondatasdkfilefield" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Class org.apache.carbondata.sdk.file.Field</h3>
+<pre><code>/**
+* Field Constructor
+* @param name name of the field
+* @param type datatype of field, specified in strings.
+*/
+public Field(String name, String type);
+</code></pre>
+<pre><code>/**
+* Field constructor
+* @param name name of the field
+* @param type datatype of the field of class DataType
+*/
+public Field(String name, DataType type);
+</code></pre>
+<h3>
+<a id="class-orgapachecarbondatasdkfileschema" class="anchor" href="#class-orgapachecarbondatasdkfileschema" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Class org.apache.carbondata.sdk.file.Schema</h3>
+<pre><code>/**
+* construct a schema with fields
+* @param fields
+*/
+public Schema(Field[] fields);
+</code></pre>
+<pre><code>/**
+* Create a Schema using JSON string, for example:
+* [
+* {"name":"string"},
+* {"age":"int"}
+* ]
+* @param json specified as string
+* @return Schema
+*/
+public static Schema parseJson(String json);
+</code></pre>
+<h3>
+<a id="class-orgapachecarbondatasdkfileavrocarbonwriter" class="anchor" href="#class-orgapachecarbondatasdkfileavrocarbonwriter" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Class org.apache.carbondata.sdk.file.AvroCarbonWriter</h3>
+<pre><code>/**
+* converts avro schema to carbon schema, required by carbonWriter
+*
+* @param avroSchemaString json formatted avro schema as string
+* @return carbon sdk schema
+*/
+public static org.apache.carbondata.sdk.file.Schema getCarbonSchemaFromAvroSchema(String avroSchemaString);
+</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/6f8949f1/content/troubleshooting.html
----------------------------------------------------------------------
diff --git a/content/troubleshooting.html b/content/troubleshooting.html
new file mode 100644
index 0000000..c668dc9
--- /dev/null
+++ b/content/troubleshooting.html
@@ -0,0 +1,366 @@
+<!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.4.1/"
+ target="_blank">Apache CarbonData 1.4.1</a></li>
+ <li>
+ <a href="https://dist.apache.org/repos/dist/release/carbondata/1.4.0/"
+ target="_blank">Apache CarbonData 1.4.0</a></li>
+ <li>
+ <a href="https://dist.apache.org/repos/dist/release/carbondata/1.3.1/"
+ target="_blank">Apache CarbonData 1.3.1</a></li>
+ <li>
+ <a href="https://dist.apache.org/repos/dist/release/carbondata/1.3.0/"
+ target="_blank">Apache CarbonData 1.3.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="troubleshooting" class="anchor" href="#troubleshooting" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Troubleshooting</h1>
+<p>This tutorial is designed to provide troubleshooting for end users and developers
+who are building, deploying, and using CarbonData.</p>
+<h2>
+<a id="when-loading-data-gets-tablestatuslock-issues" class="anchor" href="#when-loading-data-gets-tablestatuslock-issues" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>When loading data, gets tablestatus.lock issues:</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)
+java.io.FileNotFoundException: hdfs:/localhost:9000/carbon/store/default/hdfstable/tablestatus.lock (No such file or directory)
+ at java.io.FileOutputStream.open0(Native Method)
+ at java.io.FileOutputStream.open(FileOutputStream.java:270)
+ at java.io.FileOutputStream.<init>(FileOutputStream.java:213)
+ at java.io.FileOutputStream.<init>(FileOutputStream.java:101)
+</code></pre>
+<p><strong>Possible Cause</strong>
+If you use <code><hdfs path></code> as store path when creating carbonsession, may get the errors,because the default is LOCALLOCK.</p>
+<p><strong>Procedure</strong>
+Before creating carbonsession, sets as below:</p>
+<pre><code>import org.apache.carbondata.core.util.CarbonProperties
+import org.apache.carbondata.core.constants.CarbonCommonConstants
+CarbonProperties.getInstance().addProperty(CarbonCommonConstants.LOCK_TYPE, "HDFSLOCK")
+</code></pre>
+<h2>
+<a id="failed-to-load-thrift-libraries" class="anchor" href="#failed-to-load-thrift-libraries" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Failed to load thrift libraries</h2>
+<p><strong>Symptom</strong></p>
+<p>Thrift throws following exception :</p>
+<pre><code>thrift: error while loading shared libraries:
+libthriftc.so.0: cannot open shared object file: No such file or directory
+</code></pre>
+<p><strong>Possible Cause</strong></p>
+<p>The complete path to the directory containing the libraries is not configured correctly.</p>
+<p><strong>Procedure</strong></p>
+<p>Follow the Apache thrift docs at <a href="https://thrift.apache.org/docs/install" target=_blank rel="nofollow">https://thrift.apache.org/docs/install</a> to install thrift correctly.</p>
+<h2>
+<a id="failed-to-launch-the-spark-shell" class="anchor" href="#failed-to-launch-the-spark-shell" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Failed to launch the Spark Shell</h2>
+<p><strong>Symptom</strong></p>
+<p>The shell prompts the following error :</p>
+<pre><code>org.apache.spark.sql.CarbonContext$$anon$$apache$spark$sql$catalyst$analysis
+$OverrideCatalog$_setter_$org$apache$spark$sql$catalyst$analysis
+$OverrideCatalog$$overrides_$e
+</code></pre>
+<p><strong>Possible Cause</strong></p>
+<p>The Spark Version and the selected Spark Profile do not match.</p>
+<p><strong>Procedure</strong></p>
+<ol>
+<li>
+<p>Ensure your spark version and selected profile for spark are correct.</p>
+</li>
+<li>
+<p>Use the following command :</p>
+</li>
+</ol>
+<pre><code>"mvn -Pspark-2.1 -Dspark.version {yourSparkVersion} clean package"
+</code></pre>
+<p>Note : Refrain from using "mvn clean package" without specifying the profile.</p>
+<h2>
+<a id="failed-to-execute-load-query-on-cluster" class="anchor" href="#failed-to-execute-load-query-on-cluster" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Failed to execute load query on cluster.</h2>
+<p><strong>Symptom</strong></p>
+<p>Load query failed with the following exception:</p>
+<pre><code>Dictionary file is locked for updation.
+</code></pre>
+<p><strong>Possible Cause</strong></p>
+<p>The carbon.properties file is not identical in all the nodes of the cluster.</p>
+<p><strong>Procedure</strong></p>
+<p>Follow the steps to ensure the carbon.properties file is consistent across all the nodes:</p>
+<ol>
+<li>
+<p>Copy the carbon.properties file from the master node to all the other nodes in the cluster.
+For example, you can use ssh to copy this file to all the nodes.</p>
+</li>
+<li>
+<p>For the changes to take effect, restart the Spark cluster.</p>
+</li>
+</ol>
+<h2>
+<a id="failed-to-execute-insert-query-on-cluster" class="anchor" href="#failed-to-execute-insert-query-on-cluster" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Failed to execute insert query on cluster.</h2>
+<p><strong>Symptom</strong></p>
+<p>Load query failed with the following exception:</p>
+<pre><code>Dictionary file is locked for updation.
+</code></pre>
+<p><strong>Possible Cause</strong></p>
+<p>The carbon.properties file is not identical in all the nodes of the cluster.</p>
+<p><strong>Procedure</strong></p>
+<p>Follow the steps to ensure the carbon.properties file is consistent across all the nodes:</p>
+<ol>
+<li>
+<p>Copy the carbon.properties file from the master node to all the other nodes in the cluster.
+For example, you can use scp to copy this file to all the nodes.</p>
+</li>
+<li>
+<p>For the changes to take effect, restart the Spark cluster.</p>
+</li>
+</ol>
+<h2>
+<a id="failed-to-connect-to-hiveuser-with-thrift" class="anchor" href="#failed-to-connect-to-hiveuser-with-thrift" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Failed to connect to hiveuser with thrift</h2>
+<p><strong>Symptom</strong></p>
+<p>We get the following exception :</p>
+<pre><code>Cannot connect to hiveuser.
+</code></pre>
+<p><strong>Possible Cause</strong></p>
+<p>The external process does not have permission to access.</p>
+<p><strong>Procedure</strong></p>
+<p>Ensure that the Hiveuser in mysql must allow its access to the external processes.</p>
+<h2>
+<a id="failed-to-read-the-metastore-db-during-table-creation" class="anchor" href="#failed-to-read-the-metastore-db-during-table-creation" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Failed to read the metastore db during table creation.</h2>
+<p><strong>Symptom</strong></p>
+<p>We get the following exception on trying to connect :</p>
+<pre><code>Cannot read the metastore db
+</code></pre>
+<p><strong>Possible Cause</strong></p>
+<p>The metastore db is dysfunctional.</p>
+<p><strong>Procedure</strong></p>
+<p>Remove the metastore db from the carbon.metastore in the Spark Directory.</p>
+<h2>
+<a id="failed-to-load-data-on-the-cluster" class="anchor" href="#failed-to-load-data-on-the-cluster" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Failed to load data on the cluster</h2>
+<p><strong>Symptom</strong></p>
+<p>Data loading fails with the following exception :</p>
+<pre><code>Data Load failure exception
+</code></pre>
+<p><strong>Possible Cause</strong></p>
+<p>The following issue can cause the failure :</p>
+<ol>
+<li>
+<p>The core-site.xml, hive-site.xml, yarn-site and carbon.properties are not consistent across all nodes of the cluster.</p>
+</li>
+<li>
+<p>Path to hdfs ddl is not configured correctly in the carbon.properties.</p>
+</li>
+</ol>
+<p><strong>Procedure</strong></p>
+<p>Follow the steps to ensure the following configuration files are consistent across all the nodes:</p>
+<ol>
+<li>
+<p>Copy the core-site.xml, hive-site.xml, yarn-site,carbon.properties files from the master node to all the other nodes in the cluster.
+For example, you can use scp to copy this file to all the nodes.</p>
+<p>Note : Set the path to hdfs ddl in carbon.properties in the master node.</p>
+</li>
+<li>
+<p>For the changes to take effect, restart the Spark cluster.</p>
+</li>
+</ol>
+<h2>
+<a id="failed-to-insert-data-on-the-cluster" class="anchor" href="#failed-to-insert-data-on-the-cluster" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Failed to insert data on the cluster</h2>
+<p><strong>Symptom</strong></p>
+<p>Insertion fails with the following exception :</p>
+<pre><code>Data Load failure exception
+</code></pre>
+<p><strong>Possible Cause</strong></p>
+<p>The following issue can cause the failure :</p>
+<ol>
+<li>
+<p>The core-site.xml, hive-site.xml, yarn-site and carbon.properties are not consistent across all nodes of the cluster.</p>
+</li>
+<li>
+<p>Path to hdfs ddl is not configured correctly in the carbon.properties.</p>
+</li>
+</ol>
+<p><strong>Procedure</strong></p>
+<p>Follow the steps to ensure the following configuration files are consistent across all the nodes:</p>
+<ol>
+<li>
+<p>Copy the core-site.xml, hive-site.xml, yarn-site,carbon.properties files from the master node to all the other nodes in the cluster.
+For example, you can use scp to copy this file to all the nodes.</p>
+<p>Note : Set the path to hdfs ddl in carbon.properties in the master node.</p>
+</li>
+<li>
+<p>For the changes to take effect, restart the Spark cluster.</p>
+</li>
+</ol>
+<h2>
+<a id="failed-to-execute-concurrent-operationsloadinsertupdate-on-table-by-multiple-workers" class="anchor" href="#failed-to-execute-concurrent-operationsloadinsertupdate-on-table-by-multiple-workers" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Failed to execute Concurrent Operations(Load,Insert,Update) on table by multiple workers.</h2>
+<p><strong>Symptom</strong></p>
+<p>Execution fails with the following exception :</p>
+<pre><code>Table is locked for updation.
+</code></pre>
+<p><strong>Possible Cause</strong></p>
+<p>Concurrency not supported.</p>
+<p><strong>Procedure</strong></p>
+<p>Worker must wait for the query execution to complete and the table to release the lock for another query execution to succeed.</p>
+<h2>
+<a id="failed-to-create-a-table-with-a-single-numeric-column" class="anchor" href="#failed-to-create-a-table-with-a-single-numeric-column" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Failed to create a table with a single numeric column.</h2>
+<p><strong>Symptom</strong></p>
+<p>Execution fails with the following exception :</p>
+<pre><code>Table creation fails.
+</code></pre>
+<p><strong>Possible Cause</strong></p>
+<p>Behaviour not supported.</p>
+<p><strong>Procedure</strong></p>
+<p>A single column that can be considered as dimension is mandatory for table creation.</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
[06/20] carbondata-site git commit: modified for 1.5.0 version
Posted by ch...@apache.org.
http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6ad7599a/src/main/webapp/configuration-parameters.html
----------------------------------------------------------------------
diff --git a/src/main/webapp/configuration-parameters.html b/src/main/webapp/configuration-parameters.html
index ab89576..ff8e9ad 100644
--- a/src/main/webapp/configuration-parameters.html
+++ b/src/main/webapp/configuration-parameters.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>
@@ -212,7 +220,7 @@
<div>
<h1>
<a id="configuring-carbondata" class="anchor" href="#configuring-carbondata" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Configuring CarbonData</h1>
-<p>This guide explains the configurations that can be used to tune CarbonData to achieve better performance.Most of the properties that control the internal settings have reasonable default values.They are listed along with the properties along with explanation.</p>
+<p>This guide explains the configurations that can be used to tune CarbonData to achieve better performance.Most of the properties that control the internal settings have reasonable default values. They are listed along with the properties along with explanation.</p>
<ul>
<li><a href="#system-configuration">System Configuration</a></li>
<li><a href="#data-loading-configuration">Data Loading Configuration</a></li>
@@ -236,42 +244,42 @@
<tr>
<td>carbon.storelocation</td>
<td>spark.sql.warehouse.dir property value</td>
-<td>Location where CarbonData will create the store, and write the data in its custom format. If not specified,the path defaults to spark.sql.warehouse.dir property. NOTE: Store location should be in HDFS.</td>
+<td>Location where CarbonData will create the store, and write the data in its custom format. If not specified,the path defaults to spark.sql.warehouse.dir property. <strong>NOTE:</strong> Store location should be in HDFS.</td>
</tr>
<tr>
<td>carbon.ddl.base.hdfs.url</td>
<td>(none)</td>
-<td>To simplify and shorten the path to be specified in DDL/DML commands, this property is supported.This property is used to configure the HDFS relative path, the path configured in carbon.ddl.base.hdfs.url will be appended to the HDFS path configured in fs.defaultFS of core-site.xml. If this path is configured, then user need not pass the complete path while dataload. For example: If absolute path of the csv file is hdfs://10.18.101.155:54310/data/cnbc/2016/xyz.csv, the path "hdfs://10.18.101.155:54310" will come from property fs.defaultFS and user can configure the /data/cnbc/ as carbon.ddl.base.hdfs.url. Now while dataload user can specify the csv path as /2016/xyz.csv.</td>
+<td>To simplify and shorten the path to be specified in DDL/DML commands, this property is supported. This property is used to configure the HDFS relative path, the path configured in carbon.ddl.base.hdfs.url will be appended to the HDFS path configured in fs.defaultFS of core-site.xml. If this path is configured, then user need not pass the complete path while dataload. For example: If absolute path of the csv file is hdfs://10.18.101.155:54310/data/cnbc/2016/xyz.csv, the path "hdfs://10.18.101.155:54310" will come from property fs.defaultFS and user can configure the /data/cnbc/ as carbon.ddl.base.hdfs.url. Now while dataload user can specify the csv path as /2016/xyz.csv.</td>
</tr>
<tr>
<td>carbon.badRecords.location</td>
<td>(none)</td>
-<td>CarbonData can detect the records not conforming to defined table schema and isolate them as bad records.This property is used to specify where to store such bad records.</td>
+<td>CarbonData can detect the records not conforming to defined table schema and isolate them as bad records. This property is used to specify where to store such bad records.</td>
</tr>
<tr>
<td>carbon.streaming.auto.handoff.enabled</td>
<td>true</td>
-<td>CarbonData supports storing of streaming data.To have high throughput for streaming, the data is written in Row format which is highly optimized for write, but performs poorly for query.When this property is true and when the streaming data size reaches <em><strong>carbon.streaming.segment.max.size</strong></em>, CabonData will automatically convert the data to columnar format and optimize it for faster querying.<strong>NOTE:</strong> It is not recommended to keep the default value which is true.</td>
+<td>CarbonData supports storing of streaming data. To have high throughput for streaming, the data is written in Row format which is highly optimized for write, but performs poorly for query. When this property is true and when the streaming data size reaches <em><strong>carbon.streaming.segment.max.size</strong></em>, CabonData will automatically convert the data to columnar format and optimize it for faster querying.<strong>NOTE:</strong> It is not recommended to keep the default value which is true.</td>
</tr>
<tr>
<td>carbon.streaming.segment.max.size</td>
<td>1024000000</td>
-<td>CarbonData writes streaming data in row format which is optimized for high write throughput.This property defines the maximum size of data to be held is row format, beyond which it will be converted to columnar format in order to support high performane query, provided <em><strong>carbon.streaming.auto.handoff.enabled</strong></em> is true. <strong>NOTE:</strong> Setting higher value will impact the streaming ingestion. The value has to be configured in bytes.</td>
+<td>CarbonData writes streaming data in row format which is optimized for high write throughput. This property defines the maximum size of data to be held is row format, beyond which it will be converted to columnar format in order to support high performance query, provided <em><strong>carbon.streaming.auto.handoff.enabled</strong></em> is true. <strong>NOTE:</strong> Setting higher value will impact the streaming ingestion. The value has to be configured in bytes.</td>
</tr>
<tr>
<td>carbon.query.show.datamaps</td>
<td>true</td>
-<td>CarbonData stores datamaps as independent tables so as to allow independent maintenance to some extent.When this property is true,which is by default, show tables command will list all the tables including datatmaps(eg: Preaggregate table), else datamaps will be excluded from the table list.<strong>NOTE:</strong> It is generally not required for the user to do any maintenance operations on these tables and hence not required to be seen.But it is shown by default so that user or admin can get clear understanding of the system for capacity planning.</td>
+<td>CarbonData stores datamaps as independent tables so as to allow independent maintenance to some extent. When this property is true,which is by default, show tables command will list all the tables including datatmaps(eg: Preaggregate table), else datamaps will be excluded from the table list.<strong>NOTE:</strong> It is generally not required for the user to do any maintenance operations on these tables and hence not required to be seen.But it is shown by default so that user or admin can get clear understanding of the system for capacity planning.</td>
</tr>
<tr>
<td>carbon.segment.lock.files.preserve.hours</td>
<td>48</td>
-<td>In order to support parallel data loading onto the same table, CarbonData sequences(locks) at the granularity of segments.Operations affecting the segment(like IUD, alter) are blocked from parallel operations.This property value indicates the number of hours the segment lock files will be preserved after dataload. These lock files will be deleted with the clean command after the configured number of hours.</td>
+<td>In order to support parallel data loading onto the same table, CarbonData sequences(locks) at the granularity of segments.Operations affecting the segment(like IUD, alter) are blocked from parallel operations. This property value indicates the number of hours the segment lock files will be preserved after dataload. These lock files will be deleted with the clean command after the configured number of hours.</td>
</tr>
<tr>
<td>carbon.timestamp.format</td>
<td>yyyy-MM-dd HH:mm:ss</td>
-<td>CarbonData can understand data of timestamp type and process it in special manner.It can be so that the format of Timestamp data is different from that understood by CarbonData by default.This configuration allows users to specify the format of Timestamp in their data.</td>
+<td>CarbonData can understand data of timestamp type and process it in special manner.It can be so that the format of Timestamp data is different from that understood by CarbonData by default. This configuration allows users to specify the format of Timestamp in their data.</td>
</tr>
<tr>
<td>carbon.lock.type</td>
@@ -286,27 +294,32 @@
<tr>
<td>carbon.unsafe.working.memory.in.mb</td>
<td>512</td>
-<td>CarbonData supports storing data in off-heap memory for certain operations during data loading and query.This helps to avoid the Java GC and thereby improve the overall performance.The Minimum value recommeded is 512MB.Any value below this is reset to default value of 512MB.<strong>NOTE:</strong> The below formulas explain how to arrive at the off-heap size required.Memory Required For Data Loading:(<em>carbon.number.of.cores.while.loading</em>) * (Number of tables to load in parallel) * (<em>offheap.sort.chunk.size.inmb</em> + <em>carbon.blockletgroup.size.in.mb</em> + <em>carbon.blockletgroup.size.in.mb</em>/3.5 ). Memory required for Query:SPARK_EXECUTOR_INSTANCES * (<em>carbon.blockletgroup.size.in.mb</em> + <em>carbon.blockletgroup.size.in.mb</em> * 3.5) * spark.executor.cores</td>
+<td>CarbonData supports storing data in off-heap memory for certain operations during data loading and query. This helps to avoid the Java GC and thereby improve the overall performance. The Minimum value recommeded is 512MB. Any value below this is reset to default value of 512MB. <strong>NOTE:</strong> The below formulas explain how to arrive at the off-heap size required.Memory Required For Data Loading:(<em>carbon.number.of.cores.while.loading</em>) * (Number of tables to load in parallel) * (<em>offheap.sort.chunk.size.inmb</em> + <em>carbon.blockletgroup.size.in.mb</em> + <em>carbon.blockletgroup.size.in.mb</em>/3.5 ). Memory required for Query:SPARK_EXECUTOR_INSTANCES * (<em>carbon.blockletgroup.size.in.mb</em> + <em>carbon.blockletgroup.size.in.mb</em> * 3.5) * spark.executor.cores</td>
+</tr>
+<tr>
+<td>carbon.unsafe.driver.working.memory.in.mb</td>
+<td>60% of JVM Heap Memory</td>
+<td>CarbonData supports storing data in unsafe on-heap memory in driver for certain operations like insert into, query for loading datamap cache. The Minimum value recommended is 512MB.</td>
</tr>
<tr>
<td>carbon.update.sync.folder</td>
<td>/tmp/carbondata</td>
-<td>CarbonData maintains last modification time entries in modifiedTime.htmlt to determine the schema changes and reload only when necessary.This configuration specifies the path where the file needs to be written.</td>
+<td>CarbonData maintains last modification time entries in modifiedTime.htmlt to determine the schema changes and reload only when necessary. This configuration specifies the path where the file needs to be written.</td>
</tr>
<tr>
<td>carbon.invisible.segments.preserve.count</td>
<td>200</td>
-<td>CarbonData maintains each data load entry in tablestatus file. The entries from this file are not deleted for those segments that are compacted or dropped, but are made invisible.If the number of data loads are very high, the size and number of entries in tablestatus file can become too many causing unnecessary reading of all data.This configuration specifies the number of segment entries to be maintained afte they are compacted or dropped.Beyond this, the entries are moved to a separate history tablestatus file.<strong>NOTE:</strong> The entries in tablestatus file help to identify the operations performed on CarbonData table and is also used for checkpointing during various data manupulation operations.This is similar to AUDIT file maintaining all the operations and its status.Hence the entries are never deleted but moved to a separate history file.</td>
+<td>CarbonData maintains each data load entry in tablestatus file. The entries from this file are not deleted for those segments that are compacted or dropped, but are made invisible. If the number of data loads are very high, the size and number of entries in tablestatus file can become too many causing unnecessary reading of all data. This configuration specifies the number of segment entries to be maintained afte they are compacted or dropped.Beyond this, the entries are moved to a separate history tablestatus file. <strong>NOTE:</strong> The entries in tablestatus file help to identify the operations performed on CarbonData table and is also used for checkpointing during various data manupulation operations. This is similar to AUDIT file maintaining all the operations and its status.Hence the entries are never deleted but moved to a separate history file.</td>
</tr>
<tr>
<td>carbon.lock.retries</td>
<td>3</td>
-<td>CarbonData ensures consistency of operations by blocking certain operations from running in parallel.In order to block the operations from running in parallel, lock is obtained on the table.This configuration specifies the maximum number of retries to obtain the lock for any operations other than load.<strong>NOTE:</strong> Data manupulation operations like Compaction,UPDATE,DELETE or LOADING,UPDATE,DELETE are not allowed to run in parallel.How ever data loading can happen in parallel to compaction.</td>
+<td>CarbonData ensures consistency of operations by blocking certain operations from running in parallel. In order to block the operations from running in parallel, lock is obtained on the table. This configuration specifies the maximum number of retries to obtain the lock for any operations other than load. <strong>NOTE:</strong> Data manupulation operations like Compaction,UPDATE,DELETE or LOADING,UPDATE,DELETE are not allowed to run in parallel.How ever data loading can happen in parallel to compaction.</td>
</tr>
<tr>
<td>carbon.lock.retry.timeout.sec</td>
<td>5</td>
-<td>Specifies the interval between the retries to obtain the lock for any operation other than load.<strong>NOTE:</strong> Refer to <em><strong>carbon.lock.retries</strong></em> for understanding why CarbonData uses locks for operations.</td>
+<td>Specifies the interval between the retries to obtain the lock for any operation other than load. <strong>NOTE:</strong> Refer to <em><strong>carbon.lock.retries</strong></em> for understanding why CarbonData uses locks for operations.</td>
</tr>
</tbody>
</table>
@@ -324,7 +337,7 @@
<tr>
<td>carbon.number.of.cores.while.loading</td>
<td>2</td>
-<td>Number of cores to be used while loading data.This also determines the number of threads to be used to read the input files (csv) in parallel.<strong>NOTE:</strong> This configured value is used in every data loading step to parallelize the operations. Configuring a higher value can lead to increased early thread pre-emption by OS and there by reduce the overall performance.</td>
+<td>Number of cores to be used while loading data. This also determines the number of threads to be used to read the input files (csv) in parallel.<strong>NOTE:</strong> This configured value is used in every data loading step to parallelize the operations. Configuring a higher value can lead to increased early thread pre-emption by OS and there by reduce the overall performance.</td>
</tr>
<tr>
<td>carbon.sort.size</td>
@@ -344,12 +357,12 @@
<tr>
<td>carbon.options.bad.records.logger.enable</td>
<td>false</td>
-<td>CarbonData can identify the records that are not conformant to schema and isolate them as bad records.Enabling this configuration will make CarbonData to log such bad records.<strong>NOTE:</strong> If the input data contains many bad records, logging them will slow down the over all data loading throughput.The data load operation status would depend on the configuration in <em><strong>carbon.bad.records.action</strong></em>.</td>
+<td>CarbonData can identify the records that are not conformant to schema and isolate them as bad records. Enabling this configuration will make CarbonData to log such bad records.<strong>NOTE:</strong> If the input data contains many bad records, logging them will slow down the over all data loading throughput. The data load operation status would depend on the configuration in <em><strong>carbon.bad.records.action</strong></em>.</td>
</tr>
<tr>
<td>carbon.bad.records.action</td>
<td>FAIL</td>
-<td>CarbonData in addition to identifying the bad records, can take certain actions on such data.This configuration can have four types of actions for bad records namely FORCE, REDIRECT, IGNORE and FAIL. If set to FORCE then it auto-corrects the data by storing the bad records as NULL. If set to REDIRECT then bad records are written to the raw CSV instead of being loaded. If set to IGNORE then bad records are neither loaded nor written to the raw CSV. If set to FAIL then data loading fails if any bad records are found.</td>
+<td>CarbonData in addition to identifying the bad records, can take certain actions on such data. This configuration can have four types of actions for bad records namely FORCE, REDIRECT, IGNORE and FAIL. If set to FORCE then it auto-corrects the data by storing the bad records as NULL. If set to REDIRECT then bad records are written to the raw CSV instead of being loaded. If set to IGNORE then bad records are neither loaded nor written to the raw CSV. If set to FAIL then data loading fails if any bad records are found.</td>
</tr>
<tr>
<td>carbon.options.is.empty.data.bad.record</td>
@@ -364,48 +377,48 @@
<tr>
<td>carbon.blockletgroup.size.in.mb</td>
<td>64</td>
-<td>Please refer to <a href="./file-structure-of-carbondata.html#carbondata-file-format">file-structure-of-carbondata</a> to understand the storage format of CarbonData.The data are read as a group of blocklets which are called blocklet groups. This parameter specifies the size of each blocklet group. Higher value results in better sequential IO access.The minimum value is 16MB, any value lesser than 16MB will reset to the default value (64MB).<strong>NOTE:</strong> Configuring a higher value might lead to poor performance as an entire blocklet group will have to read into memory before processing.For filter queries with limit, it is <strong>not advisable</strong> to have a bigger blocklet size.For Aggregation queries which need to return more number of rows,bigger blocklet size is advisable.</td>
+<td>Please refer to <a href="./file-structure-of-carbondata.html#carbondata-file-format">file-structure-of-carbondata</a> to understand the storage format of CarbonData. The data are read as a group of blocklets which are called blocklet groups. This parameter specifies the size of each blocklet group. Higher value results in better sequential IO access. The minimum value is 16MB, any value lesser than 16MB will reset to the default value (64MB).<strong>NOTE:</strong> Configuring a higher value might lead to poor performance as an entire blocklet group will have to read into memory before processing.For filter queries with limit, it is <strong>not advisable</strong> to have a bigger blocklet size. For Aggregation queries which need to return more number of rows,bigger blocklet size is advisable.</td>
</tr>
<tr>
<td>carbon.sort.file.write.buffer.size</td>
<td>16384</td>
-<td>CarbonData sorts and writes data to intermediate files to limit the memory usage.This configuration determines the buffer size to be used for reading and writing such files. <strong>NOTE:</strong> This configuration is useful to tune IO and derive optimal performance.Based on the OS and underlying harddisk type, these values can significantly affect the overall performance.It is ideal to tune the buffersize equivalent to the IO buffer size of the OS.Recommended range is between 10240 to 10485760 bytes.</td>
+<td>CarbonData sorts and writes data to intermediate files to limit the memory usage. This configuration determines the buffer size to be used for reading and writing such files. <strong>NOTE:</strong> This configuration is useful to tune IO and derive optimal performance.Based on the OS and underlying harddisk type, these values can significantly affect the overall performance.It is ideal to tune the buffersize equivalent to the IO buffer size of the OS.Recommended range is between 10240 to 10485760 bytes.</td>
</tr>
<tr>
<td>carbon.sort.intermediate.files.limit</td>
<td>20</td>
-<td>CarbonData sorts and writes data to intermediate files to limit the memory usage.Before writing the target carbondat file, the data in these intermediate files needs to be sorted again so as to ensure the entire data in the data load is sorted.This configuration determines the minimum number of intermediate files after which merged sort is applied on them sort the data.<strong>NOTE:</strong> Intermediate merging happens on a separate thread in the background.Number of threads used is determined by <em><strong>carbon.merge.sort.reader.thread</strong></em>.Configuring a low value will cause more time to be spent in merging these intermediate merged files which can cause more IO.Configuring a high value would cause not to use the idle threads to do intermediate sort merges.Range of recommended values are between 2 and 50</td>
+<td>CarbonData sorts and writes data to intermediate files to limit the memory usage. Before writing the target carbondat file, the data in these intermediate files needs to be sorted again so as to ensure the entire data in the data load is sorted. This configuration determines the minimum number of intermediate files after which merged sort is applied on them sort the data.<strong>NOTE:</strong> Intermediate merging happens on a separate thread in the background.Number of threads used is determined by <em><strong>carbon.merge.sort.reader.thread</strong></em>.Configuring a low value will cause more time to be spent in merging these intermediate merged files which can cause more IO.Configuring a high value would cause not to use the idle threads to do intermediate sort merges.Range of recommended values are between 2 and 50</td>
</tr>
<tr>
<td>carbon.csv.read.buffersize.byte</td>
<td>1048576</td>
-<td>CarbonData uses Hadoop InputFormat to read the csv files.This configuration value is used to pass buffer size as input for the Hadoop MR job when reading the csv files.This value is configured in bytes.<strong>NOTE:</strong> Refer to <em><strong>org.apache.hadoop.mapreduce.InputFormat</strong></em> documentation for additional information.</td>
+<td>CarbonData uses Hadoop InputFormat to read the csv files. This configuration value is used to pass buffer size as input for the Hadoop MR job when reading the csv files. This value is configured in bytes.<strong>NOTE:</strong> Refer to <em><strong>org.apache.hadoop.mapreduce.InputFormat</strong></em> documentation for additional information.</td>
</tr>
<tr>
<td>carbon.merge.sort.reader.thread</td>
<td>3</td>
-<td>CarbonData sorts and writes data to intermediate files to limit the memory usage.When the intermediate files reaches <em><strong>carbon.sort.intermediate.files.limit</strong></em> the files will be merged,the number of threads specified in this configuration will be used to read the intermediate files for performing merge sort.<strong>NOTE:</strong> Refer to <em><strong>carbon.sort.intermediate.files.limit</strong></em> for operation description.Configuring less number of threads can cause merging to slow down over loading process where as configuring more number of threads can cause thread contention with threads in other data loading steps.Hence configure a fraction of <em><strong>carbon.number.of.cores.while.loading</strong></em>.</td>
+<td>CarbonData sorts and writes data to intermediate files to limit the memory usage. When the intermediate files reaches <em><strong>carbon.sort.intermediate.files.limit</strong></em> the files will be merged,the number of threads specified in this configuration will be used to read the intermediate files for performing merge sort.<strong>NOTE:</strong> Refer to <em><strong>carbon.sort.intermediate.files.limit</strong></em> for operation description.Configuring less number of threads can cause merging to slow down over loading process where as configuring more number of threads can cause thread contention with threads in other data loading steps.Hence configure a fraction of <em><strong>carbon.number.of.cores.while.loading</strong></em>.</td>
</tr>
<tr>
<td>carbon.concurrent.lock.retries</td>
<td>100</td>
-<td>CarbonData supports concurrent data loading onto same table.To ensure the loading status is correctly updated into the system,locks are used to sequence the status updation step.This configuration specifies the maximum number of retries to obtain the lock for updating the load status.<strong>NOTE:</strong> This value is high as more number of concurrent loading happens,more the chances of not able to obtain the lock when tried.Adjust this value according to the number of concurrent loading to be supported by the system.</td>
+<td>CarbonData supports concurrent data loading onto same table. To ensure the loading status is correctly updated into the system,locks are used to sequence the status updation step. This configuration specifies the maximum number of retries to obtain the lock for updating the load status. <strong>NOTE:</strong> This value is high as more number of concurrent loading happens,more the chances of not able to obtain the lock when tried. Adjust this value according to the number of concurrent loading to be supported by the system.</td>
</tr>
<tr>
<td>carbon.concurrent.lock.retry.timeout.sec</td>
<td>1</td>
-<td>Specifies the interval between the retries to obtain the lock for concurrent operations.<strong>NOTE:</strong> Refer to <em><strong>carbon.concurrent.lock.retries</strong></em> for understanding why CarbonData uses locks during data loading operations.</td>
+<td>Specifies the interval between the retries to obtain the lock for concurrent operations. <strong>NOTE:</strong> Refer to <em><strong>carbon.concurrent.lock.retries</strong></em> for understanding why CarbonData uses locks during data loading operations.</td>
</tr>
<tr>
<td>carbon.skip.empty.line</td>
<td>false</td>
-<td>The csv files givent to CarbonData for loading can contain empty lines.Based on the business scenario, this empty line might have to be ignored or needs to be treated as NULL value for all columns.In order to define this business behavior, this configuration is provided.<strong>NOTE:</strong> In order to consider NULL values for non string columns and continue with data load, <em><strong>carbon.bad.records.action</strong></em> need to be set to <strong>FORCE</strong>;else data load will be failed as bad records encountered.</td>
+<td>The csv files givent to CarbonData for loading can contain empty lines. Based on the business scenario, this empty line might have to be ignored or needs to be treated as NULL value for all columns.In order to define this business behavior, this configuration is provided.<strong>NOTE:</strong> In order to consider NULL values for non string columns and continue with data load, <em><strong>carbon.bad.records.action</strong></em> need to be set to <strong>FORCE</strong>;else data load will be failed as bad records encountered.</td>
</tr>
<tr>
<td>carbon.enable.calculate.size</td>
<td>true</td>
<td>
-<strong>For Load Operation</strong>: Setting this property calculates the size of the carbon data file (.carbondata) and carbon index file (.carbonindex) for every load and updates the table status file. <strong>For Describe Formatted</strong>: Setting this property calculates the total size of the carbon data files and carbon index files for the respective table and displays in describe formatted command.<strong>NOTE:</strong> This is useful to determine the overall size of the carbondata table and also get an idea of how the table is growing in order to take up other backup strategy decisions.</td>
+<strong>For Load Operation</strong>: Setting this property calculates the size of the carbon data file (.carbondata) and carbon index file (.carbonindex) for every load and updates the table status file. <strong>For Describe Formatted</strong>: Setting this property calculates the total size of the carbon data files and carbon index files for the respective table and displays in describe formatted command. <strong>NOTE:</strong> This is useful to determine the overall size of the carbondata table and also get an idea of how the table is growing in order to take up other backup strategy decisions.</td>
</tr>
<tr>
<td>carbon.cutOffTimestamp</td>
@@ -415,118 +428,128 @@
<tr>
<td>carbon.timegranularity</td>
<td>SECOND</td>
-<td>The configuration is used to specify the data granularity level such as DAY, HOUR, MINUTE, or SECOND.This helps to store more than 68 years of data into CarbonData.</td>
+<td>The configuration is used to specify the data granularity level such as DAY, HOUR, MINUTE, or SECOND. This helps to store more than 68 years of data into CarbonData.</td>
</tr>
<tr>
<td>carbon.use.local.dir</td>
<td>false</td>
-<td>CarbonData,during data loading, writes files to local temp directories before copying the files to HDFS.This configuration is used to specify whether CarbonData can write locally to tmp directory of the container or to the YARN application directory.</td>
+<td>CarbonData,during data loading, writes files to local temp directories before copying the files to HDFS. This configuration is used to specify whether CarbonData can write locally to tmp directory of the container or to the YARN application directory.</td>
</tr>
<tr>
<td>carbon.use.multiple.temp.dir</td>
<td>false</td>
-<td>When multiple disks are present in the system, YARN is generally configured with multiple disks to be used as temp directories for managing the containers.This configuration specifies whether to use multiple YARN local directories during data loading for disk IO load balancing.Enable <em><strong>carbon.use.local.dir</strong></em> for this configuration to take effect.<strong>NOTE:</strong> Data Loading is an IO intensive operation whose performance can be limited by the disk IO threshold, particularly during multi table concurrent data load.Configuring this parameter, balances the disk IO across multiple disks there by improving the over all load performance.</td>
+<td>When multiple disks are present in the system, YARN is generally configured with multiple disks to be used as temp directories for managing the containers. This configuration specifies whether to use multiple YARN local directories during data loading for disk IO load balancing.Enable <em><strong>carbon.use.local.dir</strong></em> for this configuration to take effect. <strong>NOTE:</strong> Data Loading is an IO intensive operation whose performance can be limited by the disk IO threshold, particularly during multi table concurrent data load.Configuring this parameter, balances the disk IO across multiple disks there by improving the over all load performance.</td>
</tr>
<tr>
<td>carbon.sort.temp.compressor</td>
<td>(none)</td>
-<td>CarbonData writes every <em><strong>carbon.sort.size</strong></em> number of records to intermediate temp files during data loading to ensure memory footprint is within limits.These temporary files cab be compressed and written in order to save the storage space.This configuration specifies the name of compressor to be used to compress the intermediate sort temp files during sort procedure in data loading.The valid values are 'SNAPPY','GZIP','BZIP2','LZ4','ZSTD' and empty. By default, empty means that Carbondata will not compress the sort temp files.<strong>NOTE:</strong> Compressor will be useful if you encounter disk bottleneck.Since the data needs to be compressed and decompressed,it involves additional CPU cycles,but is compensated by the high IO throughput due to less data to be written or read from the disks.</td>
+<td>CarbonData writes every <em><strong>carbon.sort.size</strong></em> number of records to intermediate temp files during data loading to ensure memory footprint is within limits. These temporary files can be compressed and written in order to save the storage space. This configuration specifies the name of compressor to be used to compress the intermediate sort temp files during sort procedure in data loading. The valid values are 'SNAPPY','GZIP','BZIP2','LZ4','ZSTD' and empty. By default, empty means that Carbondata will not compress the sort temp files. <strong>NOTE:</strong> Compressor will be useful if you encounter disk bottleneck.Since the data needs to be compressed and decompressed,it involves additional CPU cycles,but is compensated by the high IO throughput due to less data to be written or read from the disks.</td>
</tr>
<tr>
<td>carbon.load.skewedDataOptimization.enabled</td>
<td>false</td>
-<td>During data loading,CarbonData would divide the number of blocks equally so as to ensure all executors process same number of blocks.This mechanism satisfies most of the scenarios and ensures maximum parallel processing for optimal data loading performance.In some business scenarios, there might be scenarios where the size of blocks vary significantly and hence some executors would have to do more work if they get blocks containing more data. This configuration enables size based block allocation strategy for data loading.When loading, carbondata will use file size based block allocation strategy for task distribution. It will make sure that all the executors process the same size of data.<strong>NOTE:</strong> This configuration is useful if the size of your input data files varies widely, say 1MB~1GB.For this configuration to work effectively,knowing the data pattern and size is important and necessary.</td>
+<td>During data loading,CarbonData would divide the number of blocks equally so as to ensure all executors process same number of blocks. This mechanism satisfies most of the scenarios and ensures maximum parallel processing for optimal data loading performance.In some business scenarios, there might be scenarios where the size of blocks vary significantly and hence some executors would have to do more work if they get blocks containing more data. This configuration enables size based block allocation strategy for data loading. When loading, carbondata will use file size based block allocation strategy for task distribution. It will make sure that all the executors process the same size of data.<strong>NOTE:</strong> This configuration is useful if the size of your input data files varies widely, say 1MB to 1GB.For this configuration to work effectively,knowing the data pattern and size is important and necessary.</td>
</tr>
<tr>
<td>carbon.load.min.size.enabled</td>
<td>false</td>
-<td>During Data Loading, CarbonData would divide the number of files among the available executors to parallelize the loading operation.When the input data files are very small, this action causes to generate many small carbondata files.This configuration determines whether to enable node minumun input data size allocation strategy for data loading.It will make sure that the node load the minimum amount of data there by reducing number of carbondata files.<strong>NOTE:</strong> This configuration is useful if the size of the input data files are very small, like 1MB~256MB.Refer to <em><strong>load_min_size_inmb</strong></em> to configure the minimum size to be considered for splitting files among executors.</td>
+<td>During Data Loading, CarbonData would divide the number of files among the available executors to parallelize the loading operation. When the input data files are very small, this action causes to generate many small carbondata files. This configuration determines whether to enable node minumun input data size allocation strategy for data loading.It will make sure that the node load the minimum amount of data there by reducing number of carbondata files.<strong>NOTE:</strong> This configuration is useful if the size of the input data files are very small, like 1MB to 256MB.Refer to <em><strong>load_min_size_inmb</strong></em> to configure the minimum size to be considered for splitting files among executors.</td>
</tr>
<tr>
<td>enable.data.loading.statistics</td>
<td>false</td>
-<td>CarbonData has extensive logging which would be useful for debugging issues related to performance or hard to locate issues.This configuration when made <em><strong>true</strong></em> would log additional data loading statistics information to more accurately locate the issues being debugged.<strong>NOTE:</strong> Enabling this would log more debug information to log files, there by increasing the log files size significantly in short span of time.It is advised to configure the log files size, retention of log files parameters in log4j properties appropriately.Also extensive logging is an increased IO operation and hence over all data loading performance might get reduced.Therefore it is recommened to enable this configuration only for the duration of debugging.</td>
+<td>CarbonData has extensive logging which would be useful for debugging issues related to performance or hard to locate issues. This configuration when made <em><strong>true</strong></em> would log additional data loading statistics information to more accurately locate the issues being debugged. <strong>NOTE:</strong> Enabling this would log more debug information to log files, there by increasing the log files size significantly in short span of time.It is advised to configure the log files size, retention of log files parameters in log4j properties appropriately. Also extensive logging is an increased IO operation and hence over all data loading performance might get reduced. Therefore it is recommended to enable this configuration only for the duration of debugging.</td>
</tr>
<tr>
<td>carbon.dictionary.chunk.size</td>
<td>10000</td>
-<td>CarbonData generates dictionary keys and writes them to separate dictionary file during data loading.To optimize the IO, this configuration determines the number of dictionary keys to be persisted to dictionary file at a time.<strong>NOTE:</strong> Writing to file also serves as a commit point to the dictionary generated.Increasing more values in memory causes more data loss during system or application failure.It is advised to alter this configuration judiciously.</td>
+<td>CarbonData generates dictionary keys and writes them to separate dictionary file during data loading. To optimize the IO, this configuration determines the number of dictionary keys to be persisted to dictionary file at a time. <strong>NOTE:</strong> Writing to file also serves as a commit point to the dictionary generated.Increasing more values in memory causes more data loss during system or application failure.It is advised to alter this configuration judiciously.</td>
</tr>
<tr>
<td>dictionary.worker.threads</td>
<td>1</td>
-<td>CarbonData supports Optimized data loading by relying on a dictionary server.Dictionary server helps to maintain dictionary values independent of the data loading and there by avoids reading the same input data multiples times.This configuration determines the number of concurrent dictionary generation or request that needs to be served by the dictionary server.<strong>NOTE:</strong> This configuration takes effect when <em><strong>carbon.options.single.pass</strong></em> is configured as true.Please refer to <em>carbon.options.single.pass</em>to understand how dictionary server optimizes data loading.</td>
+<td>CarbonData supports Optimized data loading by relying on a dictionary server. Dictionary server helps to maintain dictionary values independent of the data loading and there by avoids reading the same input data multiples times. This configuration determines the number of concurrent dictionary generation or request that needs to be served by the dictionary server. <strong>NOTE:</strong> This configuration takes effect when <em><strong>carbon.options.single.pass</strong></em> is configured as true.Please refer to <em>carbon.options.single.pass</em>to understand how dictionary server optimizes data loading.</td>
</tr>
<tr>
<td>enable.unsafe.sort</td>
<td>true</td>
-<td>CarbonData supports unsafe operations of Java to avoid GC overhead for certain operations.This configuration enables to use unsafe functions in CarbonData.<strong>NOTE:</strong> For operations like data loading, which generates more short lived Java objects, Java GC can be a bottle neck.Using unsafe can overcome the GC overhead and improve the overall performance.</td>
+<td>CarbonData supports unsafe operations of Java to avoid GC overhead for certain operations. This configuration enables to use unsafe functions in CarbonData. <strong>NOTE:</strong> For operations like data loading, which generates more short lived Java objects, Java GC can be a bottle neck. Using unsafe can overcome the GC overhead and improve the overall performance.</td>
</tr>
<tr>
<td>enable.offheap.sort</td>
<td>true</td>
-<td>CarbonData supports storing data in off-heap memory for certain operations during data loading and query.This helps to avoid the Java GC and thereby improve the overall performance.This configuration enables using off-heap memory for sorting of data during data loading.<strong>NOTE:</strong> <em><strong>enable.unsafe.sort</strong></em> configuration needs to be configured to true for using off-heap</td>
+<td>CarbonData supports storing data in off-heap memory for certain operations during data loading and query. This helps to avoid the Java GC and thereby improve the overall performance. This configuration enables using off-heap memory for sorting of data during data loading.<strong>NOTE:</strong> <em><strong>enable.unsafe.sort</strong></em> configuration needs to be configured to true for using off-heap</td>
</tr>
<tr>
<td>enable.inmemory.merge.sort</td>
<td>false</td>
-<td>CarbonData sorts and writes data to intermediate files to limit the memory usage.These intermediate files needs to be sorted again using merge sort before writing to the final carbondata file.Performing merge sort in memory would increase the sorting performance at the cost of increased memory footprint. This Configuration specifies to do in-memory merge sort or to do file based merge sort.</td>
+<td>CarbonData sorts and writes data to intermediate files to limit the memory usage. These intermediate files needs to be sorted again using merge sort before writing to the final carbondata file.Performing merge sort in memory would increase the sorting performance at the cost of increased memory footprint. This Configuration specifies to do in-memory merge sort or to do file based merge sort.</td>
</tr>
<tr>
<td>carbon.load.sort.scope</td>
<td>LOCAL_SORT</td>
-<td>CarbonData can support various sorting options to match the balance between load and query performance.LOCAL_SORT:All the data given to an executor in the single load is fully sorted and written to carondata files.Data loading performance is reduced a little as the entire data needs to be sorted in the executor.BATCH_SORT:Sorts the data in batches of configured size and writes to carbondata files.Data loading performance increases as the entire data need not be sorted.But query performance will get reduced due to false positives in block pruning and also due to more number of carbondata files written.Due to more number of carbondata files, if identified blocks > cluster parallelism, query performance and concurrency will get reduced.GLOBAL SORT:Entire data in the data load is fully sorted and written to carbondata files.Data loading perfromance would get reduced as the entire data needs to be sorted.But the query performance increases significantly due to very less false posi
tives and concurrency is also improved.<strong>NOTE:</strong> when BATCH_SORTis configured, it is recommended to keep <em><strong>carbon.load.batch.sort.size.inmb</strong></em> > <em><strong>carbon.blockletgroup.size.in.mb</strong></em>
+<td>CarbonData can support various sorting options to match the balance between load and query performance. LOCAL_SORT:All the data given to an executor in the single load is fully sorted and written to carbondata files. Data loading performance is reduced a little as the entire data needs to be sorted in the executor. BATCH_SORT:Sorts the data in batches of configured size and writes to carbondata files. Data loading performance increases as the entire data need not be sorted.But query performance will get reduced due to false positives in block pruning and also due to more number of carbondata files written.Due to more number of carbondata files, if identified blocks > cluster parallelism, query performance and concurrency will get reduced.GLOBAL SORT:Entire data in the data load is fully sorted and written to carbondata files. Data loading performance would get reduced as the entire data needs to be sorted.But the query performance increases significantly due to very less fals
e positives and concurrency is also improved. <strong>NOTE:</strong> when BATCH_SORT is configured, it is recommended to keep <em><strong>carbon.load.batch.sort.size.inmb</strong></em> > <em><strong>carbon.blockletgroup.size.in.mb</strong></em>
</td>
</tr>
<tr>
<td>carbon.load.batch.sort.size.inmb</td>
<td>0</td>
-<td>When <em><strong>carbon.load.sort.scope</strong></em> is configured as <em><strong>BATCH_SORT</strong></em>,This configuration needs to be added to specify the batch size for sorting and writing to carbondata files.<strong>NOTE:</strong> It is recommended to keep the value around 45% of <em><strong>carbon.sort.storage.inmemory.size.inmb</strong></em> to avoid spill to disk.Also it is recommended to keep the value higher than <em><strong>carbon.blockletgroup.size.in.mb</strong></em>. Refer to <em>carbon.load.sort.scope</em> for more information on sort options and the advantages/disadvantges of each option.</td>
+<td>When <em><strong>carbon.load.sort.scope</strong></em> is configured as <em><strong>BATCH_SORT</strong></em>, this configuration needs to be added to specify the batch size for sorting and writing to carbondata files. <strong>NOTE:</strong> It is recommended to keep the value around 45% of <em><strong>carbon.sort.storage.inmemory.size.inmb</strong></em> to avoid spill to disk. Also it is recommended to keep the value higher than <em><strong>carbon.blockletgroup.size.in.mb</strong></em>. Refer to <em>carbon.load.sort.scope</em> for more information on sort options and the advantages/disadvantages of each option.</td>
</tr>
<tr>
<td>carbon.dictionary.server.port</td>
<td>2030</td>
-<td>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.Single pass loading can be enabled using the option <em><strong>carbon.options.single.pass</strong></em>.When this option is specified, a dictionary server will be internally started to handle the dictionary generation and query requests.This configuration specifies the port on which the server need to listen for incoming requests.Port value ranges between 0-65535</td>
+<td>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.Single pass loading can be enabled using the option <em><strong>carbon.options.single.pass</strong></em>. When this option is specified, a dictionary server will be internally started to handle the dictionary generation and query requests. This configuration specifies the port on which the server need to listen for incoming requests.Port value ranges between 0-65535</td>
</tr>
<tr>
<td>carbon.merge.sort.prefetch</td>
<td>true</td>
-<td>CarbonData writes every <em><strong>carbon.sort.size</strong></em> number of records to intermediate temp files during data loading to ensure memory footprint is within limits.These intermediate temp files will have to be sorted using merge sort before writing into CarbonData format.This configuration enables pre fetching of data from these temp files in order to optimize IO and speed up data loading process.</td>
+<td>CarbonData writes every <em><strong>carbon.sort.size</strong></em> number of records to intermediate temp files during data loading to ensure memory footprint is within limits. These intermediate temp files will have to be sorted using merge sort before writing into CarbonData format. This configuration enables pre fetching of data from these temp files in order to optimize IO and speed up data loading process.</td>
</tr>
<tr>
<td>carbon.loading.prefetch</td>
<td>false</td>
-<td>CarbonData uses univocity parser to read csv files.This configuration is used to inform the parser whether it can prefetch the data from csv files to speed up the reading.<strong>NOTE:</strong> Enabling prefetch improves the data loading performance, but needs higher memory to keep more records which are read ahead from disk.</td>
+<td>CarbonData uses univocity parser to read csv files. This configuration is used to inform the parser whether it can prefetch the data from csv files to speed up the reading.<strong>NOTE:</strong> Enabling prefetch improves the data loading performance, but needs higher memory to keep more records which are read ahead from disk.</td>
</tr>
<tr>
<td>carbon.prefetch.buffersize</td>
<td>1000</td>
-<td>When the configuration <em><strong>carbon.merge.sort.prefetch</strong></em> is configured to true, we need to set the number of records that can be prefetched.This configuration is used specify the number of records to be prefetched.**NOTE: **Configuring more number of records to be prefetched increases memory footprint as more records will have to be kept in memory.</td>
+<td>When the configuration <em><strong>carbon.merge.sort.prefetch</strong></em> is configured to true, we need to set the number of records that can be prefetched. This configuration is used specify the number of records to be prefetched.**NOTE: **Configuring more number of records to be prefetched increases memory footprint as more records will have to be kept in memory.</td>
</tr>
<tr>
<td>load_min_size_inmb</td>
<td>256</td>
-<td>This configuration is used along with <em><strong>carbon.load.min.size.enabled</strong></em>.This determines the minimum size of input files to be considered for distribution among executors while data loading.<strong>NOTE:</strong> Refer to <em><strong>carbon.load.min.size.enabled</strong></em> for understanding when this configuration needs to be used and its advantages and disadvantages.</td>
+<td>This configuration is used along with <em><strong>carbon.load.min.size.enabled</strong></em>. This determines the minimum size of input files to be considered for distribution among executors while data loading.<strong>NOTE:</strong> Refer to <em><strong>carbon.load.min.size.enabled</strong></em> for understanding when this configuration needs to be used and its advantages and disadvantages.</td>
</tr>
<tr>
<td>carbon.load.sortmemory.spill.percentage</td>
<td>0</td>
-<td>During data loading, some data pages are kept in memory upto memory configured in <em><strong>carbon.sort.storage.inmemory.size.inmb</strong></em> beyond which they are spilled to disk as intermediate temporary sort files.This configuration determines after what percentage data needs to be spilled to disk.<strong>NOTE:</strong> Without this configuration, when the data pages occupy upto configured memory, new data pages would be dumped to disk and old pages are still maintained in disk.</td>
+<td>During data loading, some data pages are kept in memory upto memory configured in <em><strong>carbon.sort.storage.inmemory.size.inmb</strong></em> beyond which they are spilled to disk as intermediate temporary sort files. This configuration determines after what percentage data needs to be spilled to disk. <strong>NOTE:</strong> Without this configuration, when the data pages occupy upto configured memory, new data pages would be dumped to disk and old pages are still maintained in disk.</td>
</tr>
<tr>
-<td>carbon.load.directWriteHdfs.enabled</td>
+<td>carbon.load.directWriteToStorePath.enabled</td>
<td>false</td>
-<td>During data load all the carbondata files are written to local disk and finally copied to the target location in HDFS.Enabling this parameter will make carrbondata files to be written directly onto target HDFS location bypassing the local disk.<strong>NOTE:</strong> Writing directly to HDFS saves local disk IO(once for writing the files and again for copying to HDFS) there by improving the performance.But the drawback is when data loading fails or the application crashes, unwanted carbondata files will remain in the target HDFS location until it is cleared during next data load or by running <em>CLEAN FILES</em> DDL command</td>
+<td>During data load, all the carbondata files are written to local disk and finally copied to the target store location in HDFS/S3. Enabling this parameter will make carbondata files to be written directly onto target HDFS/S3 location bypassing the local disk.<strong>NOTE:</strong> Writing directly to HDFS/S3 saves local disk IO(once for writing the files and again for copying to HDFS/S3) there by improving the performance. But the drawback is when data loading fails or the application crashes, unwanted carbondata files will remain in the target HDFS/S3 location until it is cleared during next data load or by running <em>CLEAN FILES</em> DDL command</td>
</tr>
<tr>
<td>carbon.options.serialization.null.format</td>
<td>\N</td>
-<td>Based on the business scenarios, some columns might need to be loaded with null values.As null value cannot be written in csv files, some special characters might be adopted to specify null values.This configuration can be used to specify the null values format in the data being loaded.</td>
+<td>Based on the business scenarios, some columns might need to be loaded with null values. As null value cannot be written in csv files, some special characters might be adopted to specify null values. This configuration can be used to specify the null values format in the data being loaded.</td>
</tr>
<tr>
<td>carbon.sort.storage.inmemory.size.inmb</td>
<td>512</td>
-<td>CarbonData writes every <em><strong>carbon.sort.size</strong></em> number of records to intermediate temp files during data loading to ensure memory footprint is within limits.When <em><strong>enable.unsafe.sort</strong></em> configuration is enabled, instead of using <em><strong>carbon.sort.size</strong></em> which is based on rows count, size occupied in memory is used to determine when to flush data pages to intermediate temp files.This configuration determines the memory to be used for storing data pages in memory.<strong>NOTE:</strong> Configuring a higher values ensures more data is maintained in memory and hence increases data loading performance due to reduced or no IO.Based on the memory availability in the nodes of the cluster, configure the values accordingly.</td>
+<td>CarbonData writes every <em><strong>carbon.sort.size</strong></em> number of records to intermediate temp files during data loading to ensure memory footprint is within limits. When <em><strong>enable.unsafe.sort</strong></em> configuration is enabled, instead of using <em><strong>carbon.sort.size</strong></em> which is based on rows count, size occupied in memory is used to determine when to flush data pages to intermediate temp files. This configuration determines the memory to be used for storing data pages in memory. <strong>NOTE:</strong> Configuring a higher value ensures more data is maintained in memory and hence increases data loading performance due to reduced or no IO.Based on the memory availability in the nodes of the cluster, configure the values accordingly.</td>
+</tr>
+<tr>
+<td>carbon.column.compressor</td>
+<td>snappy</td>
+<td>CarbonData will compress the column values using the compressor specified by this configuration. Currently CarbonData supports 'snappy' and 'zstd' compressors.</td>
+</tr>
+<tr>
+<td>carbon.minmax.allowed.byte.count</td>
+<td>200</td>
+<td>CarbonData will write the min max values for string/varchar types column using the byte count specified by this configuration. Max value is 1000 bytes(500 characters) and Min value is 10 bytes(5 characters). <strong>NOTE:</strong> This property is useful for reducing the store size thereby improving the query performance but can lead to query degradation if value is not configured properly.</td>
</tr>
</tbody>
</table>
@@ -544,22 +567,22 @@
<tr>
<td>carbon.number.of.cores.while.compacting</td>
<td>2</td>
-<td>Number of cores to be used while compacting data.This also determines the number of threads to be used to read carbondata files in parallel.</td>
+<td>Number of cores to be used while compacting data. This also determines the number of threads to be used to read carbondata files in parallel.</td>
</tr>
<tr>
<td>carbon.compaction.level.threshold</td>
<td>4, 3</td>
-<td>Each CarbonData load will create one segment, if every load is small in size it will generate many small file over a period of time impacting the query performance.This configuration is for minor compaction which decides how many segments to be merged. Configuration is of the form (x,y). Compaction will be triggered for every x segments and form a single level 1 compacted segment.When the number of compacted level 1 segments reach y, compaction will be triggered again to merge them to form a single level 2 segment. For example: If it is set as 2, 3 then minor compaction will be triggered for every 2 segments. 3 is the number of level 1 compacted segments which is further compacted to new segment.<strong>NOTE:</strong> When <em><strong>carbon.enable.auto.load.merge</strong></em> is <strong>true</strong>, Configuring higher values cause overall data loading time to increase as compaction will be triggered after data loading is complete but status is not returned till compaction is
complete. But compacting more number of segments can increase query performance.Hence optimal values needs to be configured based on the business scenario.Valid values are bwteen 0 to 100.</td>
+<td>Each CarbonData load will create one segment, if every load is small in size it will generate many small file over a period of time impacting the query performance. This configuration is for minor compaction which decides how many segments to be merged. Configuration is of the form (x,y). Compaction will be triggered for every x segments and form a single level 1 compacted segment. When the number of compacted level 1 segments reach y, compaction will be triggered again to merge them to form a single level 2 segment. For example: If it is set as 2, 3 then minor compaction will be triggered for every 2 segments. 3 is the number of level 1 compacted segments which is further compacted to new segment.<strong>NOTE:</strong> When <em><strong>carbon.enable.auto.load.merge</strong></em> is <strong>true</strong>, configuring higher values cause overall data loading time to increase as compaction will be triggered after data loading is complete but status is not returned till compaction
is complete. But compacting more number of segments can increase query performance.Hence optimal values needs to be configured based on the business scenario. Valid values are between 0 to 100.</td>
</tr>
<tr>
<td>carbon.major.compaction.size</td>
<td>1024</td>
-<td>To improve query performance and All the segments can be merged and compacted to a single segment upto configured size.This Major compaction size can be configured using this parameter. Sum of the segments which is below this threshold will be merged. This value is expressed in MB.</td>
+<td>To improve query performance and all the segments can be merged and compacted to a single segment upto configured size. This Major compaction size can be configured using this parameter. Sum of the segments which is below this threshold will be merged. This value is expressed in MB.</td>
</tr>
<tr>
<td>carbon.horizontal.compaction.enable</td>
<td>true</td>
-<td>CarbonData supports DELETE/UPDATE functionality by creating delta data files for existing carbondata files.These delta files would grow as more number of DELETE/UPDATE operations are performed.Compaction of these delta files are termed as horizontal compaction.This configuration is used to turn ON/OFF horizontal compaction. After every DELETE and UPDATE statement, horizontal compaction may occur in case the delta (DELETE/ UPDATE) files becomes more than specified threshold.**NOTE: **Having many delta files will reduce the query performance as scan has to happen on all these files before the final state of data can be decided.Hence it is advisable to keep horizontal compaction enabled and configure reasonable values to <em><strong>carbon.horizontal.UPDATE.compaction.threshold</strong></em> and <em><strong>carbon.horizontal.DELETE.compaction.threshold</strong></em>
+<td>CarbonData supports DELETE/UPDATE functionality by creating delta data files for existing carbondata files. These delta files would grow as more number of DELETE/UPDATE operations are performed.Compaction of these delta files are termed as horizontal compaction. This configuration is used to turn ON/OFF horizontal compaction. After every DELETE and UPDATE statement, horizontal compaction may occur in case the delta (DELETE/ UPDATE) files becomes more than specified threshold.**NOTE: **Having many delta files will reduce the query performance as scan has to happen on all these files before the final state of data can be decided.Hence it is advisable to keep horizontal compaction enabled and configure reasonable values to <em><strong>carbon.horizontal.UPDATE.compaction.threshold</strong></em> and <em><strong>carbon.horizontal.DELETE.compaction.threshold</strong></em>
</td>
</tr>
<tr>
@@ -575,7 +598,7 @@
<tr>
<td>carbon.update.segment.parallelism</td>
<td>1</td>
-<td>CarbonData processes the UPDATE operations by grouping records belonging to a segment into a single executor task.When the amount of data to be updated is more, this behavior causes problems like restarting of executor due to low memory and data-spill related errors.This property specifies the parallelism for each segment during update.<strong>NOTE:</strong> It is recommended to set this value to a multiple of the number of executors for balance.Values range between 1 to 1000.</td>
+<td>CarbonData processes the UPDATE operations by grouping records belonging to a segment into a single executor task. When the amount of data to be updated is more, this behavior causes problems like restarting of executor due to low memory and data-spill related errors. This property specifies the parallelism for each segment during update.<strong>NOTE:</strong> It is recommended to set this value to a multiple of the number of executors for balance.Values range between 1 to 1000.</td>
</tr>
<tr>
<td>carbon.numberof.preserve.segments</td>
@@ -585,32 +608,32 @@
<tr>
<td>carbon.allowed.compaction.days</td>
<td>0</td>
-<td>This configuration is used to control on the number of recent segments that needs to be compacted, ignoring the older ones.This congifuration is in days.For Example: If the configuration is 2, then the segments which are loaded in the time frame of past 2 days only will get merged. Segments which are loaded earlier than 2 days will not be merged. This configuration is disabled by default.<strong>NOTE:</strong> This configuration is useful when a bulk of history data is loaded into the carbondata.Query on this data is less frequent.In such cases involving these segments also into compacation will affect the resource consumption, increases overall compaction time.</td>
+<td>This configuration is used to control on the number of recent segments that needs to be compacted, ignoring the older ones. This configuration is in days.For Example: If the configuration is 2, then the segments which are loaded in the time frame of past 2 days only will get merged. Segments which are loaded earlier than 2 days will not be merged. This configuration is disabled by default.<strong>NOTE:</strong> This configuration is useful when a bulk of history data is loaded into the carbondata.Query on this data is less frequent.In such cases involving these segments also into compaction will affect the resource consumption, increases overall compaction time.</td>
</tr>
<tr>
<td>carbon.enable.auto.load.merge</td>
<td>false</td>
-<td>Compaction can be automatically triggered once data load completes.This ensures that the segments are merged in time and thus query times doesnt increase with increase in segments.This configuration enables to do compaction along with data loading.**NOTE: **Compaction will be triggered once the data load completes.But the status of data load wait till the compaction is completed.Hence it might look like data loading time has increased, but thats not the case.Moreover failure of compaction will not affect the data loading status.If data load had completed successfully, the status would be updated and segments are committed.However, failure while data loading, will not trigger compaction and error is returned immediately.</td>
+<td>Compaction can be automatically triggered once data load completes. This ensures that the segments are merged in time and thus query times does not increase with increase in segments. This configuration enables to do compaction along with data loading.**NOTE: **Compaction will be triggered once the data load completes.But the status of data load wait till the compaction is completed.Hence it might look like data loading time has increased, but thats not the case.Moreover failure of compaction will not affect the data loading status.If data load had completed successfully, the status would be updated and segments are committed.However, failure while data loading, will not trigger compaction and error is returned immediately.</td>
</tr>
<tr>
<td>carbon.enable.page.level.reader.in.compaction</td>
<td>true</td>
-<td>Enabling page level reader for compaction reduces the memory usage while compacting more number of segments. It allows reading only page by page instead of reading whole blocklet to memory.<strong>NOTE:</strong> Please refer to <a href="./file-structure-of-carbondata.html#carbondata-file-format">file-structure-of-carbondata</a> to understand the storage format of CarbonData and concepts of pages.</td>
+<td>Enabling page level reader for compaction reduces the memory usage while compacting more number of segments. It allows reading only page by page instead of reading whole blocklet to memory. <strong>NOTE:</strong> Please refer to <a href="./file-structure-of-carbondata.html#carbondata-file-format">file-structure-of-carbondata</a> to understand the storage format of CarbonData and concepts of pages.</td>
</tr>
<tr>
<td>carbon.concurrent.compaction</td>
<td>true</td>
-<td>Compaction of different tables can be executed concurrently.This configuration determines whether to compact all qualifying tables in parallel or not.**NOTE: **Compacting concurrently is a resource demanding operation and needs more resouces there by affecting the query performance also.This configuration is <strong>deprecated</strong> and might be removed in future releases.</td>
+<td>Compaction of different tables can be executed concurrently. This configuration determines whether to compact all qualifying tables in parallel or not. **NOTE: **Compacting concurrently is a resource demanding operation and needs more resources there by affecting the query performance also. This configuration is <strong>deprecated</strong> and might be removed in future releases.</td>
</tr>
<tr>
<td>carbon.compaction.prefetch.enable</td>
<td>false</td>
-<td>Compaction operation is similar to Query + data load where in data from qualifying segments are queried and data loading performed to generate a new single segment.This configuration determines whether to query ahead data from segments and feed it for data loading.**NOTE: **This configuration is disabled by default as it needs extra resources for querying ahead extra data.Based on the memory availability on the cluster, user can enable it to improve compaction performance.</td>
+<td>Compaction operation is similar to Query + data load where in data from qualifying segments are queried and data loading performed to generate a new single segment. This configuration determines whether to query ahead data from segments and feed it for data loading. **NOTE: **This configuration is disabled by default as it needs extra resources for querying extra data.Based on the memory availability on the cluster, user can enable it to improve compaction performance.</td>
</tr>
<tr>
<td>carbon.merge.index.in.segment</td>
<td>true</td>
-<td>Each CarbonData file has a companion CarbonIndex file which maintains the metadata about the data.These CarbonIndex files are read and loaded into driver and is used subsequently for pruning of data during queries.These CarbonIndex files are very small in size(few KB) and are many.Reading many small files from HDFS is not efficient and leads to slow IO performance.Hence these CarbonIndex files belonging to a segment can be combined into a single file and read once there by increasing the IO throughput.This configuration enables to merge all the CarbonIndex files into a single MergeIndex file upon data loading completion.<strong>NOTE:</strong> Reading a single big file is more efficient in HDFS and IO throughput is very high.Due to this the time needed to load the index files into memory when query is received for the first time on that table is significantly reduced and there by significantly reduces the delay in serving the first query.</td>
+<td>Each CarbonData file has a companion CarbonIndex file which maintains the metadata about the data. These CarbonIndex files are read and loaded into driver and is used subsequently for pruning of data during queries. These CarbonIndex files are very small in size(few KB) and are many.Reading many small files from HDFS is not efficient and leads to slow IO performance.Hence these CarbonIndex files belonging to a segment can be combined into a single file and read once there by increasing the IO throughput. This configuration enables to merge all the CarbonIndex files into a single MergeIndex file upon data loading completion.<strong>NOTE:</strong> Reading a single big file is more efficient in HDFS and IO throughput is very high.Due to this the time needed to load the index files into memory when query is received for the first time on that table is significantly reduced and there by significantly reduces the delay in serving the first query.</td>
</tr>
</tbody>
</table>
@@ -628,12 +651,12 @@
<tr>
<td>carbon.max.driver.lru.cache.size</td>
<td>-1</td>
-<td>Maximum memory <strong>(in MB)</strong> upto which the driver process can cache the data (BTree and dictionary values). Beyond this, least recently used data will be removed from cache before loading new set of values.Default value of -1 means there is no memory limit for caching. Only integer values greater than 0 are accepted.<strong>NOTE:</strong> Minimum number of entries that needs to be removed from cache in order to load the new set of data is determined and unloaded.ie.,for example if 3 cache entries qualify for pre-emption, out of these, those entries that free up more cache memory is removed prior to others.</td>
+<td>Maximum memory <strong>(in MB)</strong> upto which the driver process can cache the data (BTree and dictionary values). Beyond this, least recently used data will be removed from cache before loading new set of values.Default value of -1 means there is no memory limit for caching. Only integer values greater than 0 are accepted. <strong>NOTE:</strong> Minimum number of entries that needs to be removed from cache in order to load the new set of data is determined and unloaded.ie.,for example if 3 cache entries qualify for pre-emption, out of these, those entries that free up more cache memory is removed prior to others. Please refer <a href="./faq.html#how-to-check-lru-cache-memory-footprint">FAQs</a> for checking LRU cache memory footprint.</td>
</tr>
<tr>
<td>carbon.max.executor.lru.cache.size</td>
<td>-1</td>
-<td>Maximum memory <strong>(in MB)</strong> upto which the executor process can cache the data (BTree and reverse dictionary values).Default value of -1 means there is no memory limit for caching. Only integer values greater than 0 are accepted.<strong>NOTE:</strong> If this parameter is not configured, then the value of <em><strong>carbon.max.driver.lru.cache.size</strong></em> will be used.</td>
+<td>Maximum memory <strong>(in MB)</strong> upto which the executor process can cache the data (BTree and reverse dictionary values).Default value of -1 means there is no memory limit for caching. Only integer values greater than 0 are accepted. <strong>NOTE:</strong> If this parameter is not configured, then the value of <em><strong>carbon.max.driver.lru.cache.size</strong></em> will be used.</td>
</tr>
<tr>
<td>max.query.execution.time</td>
@@ -643,17 +666,17 @@
<tr>
<td>carbon.enableMinMax</td>
<td>true</td>
-<td>CarbonData maintains the metadata which enables to prune unnecessary files from being scanned as per the query conditions.To achieve pruning, Min,Max of each column is maintined.Based on the filter condition in the query, certain data can be skipped from scanning by matching the filter value against the min,max values of the column(s) present in that carbondata file.This pruing enhances query performance significantly.</td>
+<td>CarbonData maintains the metadata which enables to prune unnecessary files from being scanned as per the query conditions. To achieve pruning, Min,Max of each column is maintined.Based on the filter condition in the query, certain data can be skipped from scanning by matching the filter value against the min,max values of the column(s) present in that carbondata file. This pruning enhances query performance significantly.</td>
</tr>
<tr>
<td>carbon.dynamicallocation.schedulertimeout</td>
<td>5</td>
-<td>CarbonData has its own scheduling algorithm to suggest to Spark on how many tasks needs to be launched and how much work each task need to do in a Spark cluster for any query on CarbonData.To determine the number of tasks that can be scheduled, knowing the count of active executors is necessary.When dynamic allocation is enabled on a YARN based spark cluster,execuor processes are shutdown if no request is received for a particular amount of time.The executors are brought up when the requet is received again.This configuration specifies the maximum time (unit in seconds) the carbon scheduler can wait for executor to be active. Minimum value is 5 sec and maximum value is 15 sec.**NOTE: **Waiting for longer time leads to slow query response time.Moreover it might be possible that YARN is not able to start the executors and waiting is not beneficial.</td>
+<td>CarbonData has its own scheduling algorithm to suggest to Spark on how many tasks needs to be launched and how much work each task need to do in a Spark cluster for any query on CarbonData. To determine the number of tasks that can be scheduled, knowing the count of active executors is necessary. When dynamic allocation is enabled on a YARN based spark cluster, executor processes are shutdown if no request is received for a particular amount of time. The executors are brought up when the requet is received again. This configuration specifies the maximum time (unit in seconds) the carbon scheduler can wait for executor to be active. Minimum value is 5 sec and maximum value is 15 sec.**NOTE: **Waiting for longer time leads to slow query response time.Moreover it might be possible that YARN is not able to start the executors and waiting is not beneficial.</td>
</tr>
<tr>
<td>carbon.scheduler.minregisteredresourcesratio</td>
<td>0.8</td>
-<td>Specifies the minimum resource (executor) ratio needed for starting the block distribution. The default value is 0.8, which indicates 80% of the requested resource is allocated for starting block distribution. The minimum value is 0.1 min and the maximum value is 1.0.</td>
+<td>Specifies the minimum resource (executor) ratio needed for starting the block distribution. The default value is 0.8, which indicates 80% of the requested resource is allocated for starting block distribution. The minimum value is 0.1 min and the maximum value is 1.0.</td>
</tr>
<tr>
<td>carbon.search.enabled (Alpha Feature)</td>
@@ -663,7 +686,7 @@
<tr>
<td>carbon.search.query.timeout</td>
<td>10s</td>
-<td>Time within which the result is expected from the workers;beyond which the query is terminated</td>
+<td>Time within which the result is expected from the workers, beyond which the query is terminated</td>
</tr>
<tr>
<td>carbon.search.scan.thread</td>
@@ -694,7 +717,7 @@
<tr>
<td>carbon.enable.vector.reader</td>
<td>true</td>
-<td>Spark added vector processing to optimize cpu cache miss and there by increase the query performance.This configuration enables to fetch data as columnar batch of size 4*1024 rows instead of fetching data row by row and provide it to spark so that there is improvement in select queries performance.</td>
+<td>Spark added vector processing to optimize cpu cache miss and there by increase the query performance. This configuration enables to fetch data as columnar batch of size 4*1024 rows instead of fetching data row by row and provide it to spark so that there is improvement in select queries performance.</td>
</tr>
<tr>
<td>carbon.task.distribution</td>
@@ -704,27 +727,27 @@
<tr>
<td>carbon.custom.block.distribution</td>
<td>false</td>
-<td>CarbonData has its own scheduling algorithm to suggest to Spark on how many tasks needs to be launched and how much work each task need to do in a Spark cluster for any query on CarbonData.When this configuration is true, CarbonData would distribute the available blocks to be scanned among the available number of cores.For Example:If there are 10 blocks to be scanned and only 3 tasks can be run(only 3 executor cores available in the cluster), CarbonData would combine blocks as 4,3,3 and give it to 3 tasks to run.<strong>NOTE:</strong> When this configuration is false, as per the <em><strong>carbon.task.distribution</strong></em> configuration, each block/blocklet would be given to each task.</td>
+<td>CarbonData has its own scheduling algorithm to suggest to Spark on how many tasks needs to be launched and how much work each task need to do in a Spark cluster for any query on CarbonData. When this configuration is true, CarbonData would distribute the available blocks to be scanned among the available number of cores.For Example:If there are 10 blocks to be scanned and only 3 tasks can be run(only 3 executor cores available in the cluster), CarbonData would combine blocks as 4,3,3 and give it to 3 tasks to run. <strong>NOTE:</strong> When this configuration is false, as per the <em><strong>carbon.task.distribution</strong></em> configuration, each block/blocklet would be given to each task.</td>
</tr>
<tr>
<td>enable.query.statistics</td>
<td>false</td>
-<td>CarbonData has extensive logging which would be useful for debugging issues related to performance or hard to locate issues.This configuration when made <em><strong>true</strong></em> would log additional query statistics information to more accurately locate the issues being debugged.<strong>NOTE:</strong> Enabling this would log more debug information to log files, there by increasing the log files size significantly in short span of time.It is advised to configure the log files size, retention of log files parameters in log4j properties appropriately.Also extensive logging is an increased IO operation and hence over all query performance might get reduced.Therefore it is recommened to enable this configuration only for the duration of debugging.</td>
+<td>CarbonData has extensive logging which would be useful for debugging issues related to performance or hard to locate issues. This configuration when made <em><strong>true</strong></em> would log additional query statistics information to more accurately locate the issues being debugged.<strong>NOTE:</strong> Enabling this would log more debug information to log files, there by increasing the log files size significantly in short span of time.It is advised to configure the log files size, retention of log files parameters in log4j properties appropriately. Also extensive logging is an increased IO operation and hence over all query performance might get reduced. Therefore it is recommended to enable this configuration only for the duration of debugging.</td>
</tr>
<tr>
<td>enable.unsafe.in.query.processing</td>
-<td>true</td>
-<td>CarbonData supports unsafe operations of Java to avoid GC overhead for certain operations.This configuration enables to use unsafe functions in CarbonData while scanning the data during query.</td>
+<td>false</td>
+<td>CarbonData supports unsafe operations of Java to avoid GC overhead for certain operations. This configuration enables to use unsafe functions in CarbonData while scanning the data during query.</td>
</tr>
<tr>
<td>carbon.query.validate.directqueryondatamap</td>
<td>true</td>
-<td>CarbonData supports creating pre-aggregate table datamaps as an independent tables.For some debugging purposes, it might be required to directly query from such datamap tables.This configuration allows to query on such datamaps.</td>
+<td>CarbonData supports creating pre-aggregate table datamaps as an independent tables. For some debugging purposes, it might be required to directly query from such datamap tables. This configuration allows to query on such datamaps.</td>
</tr>
<tr>
<td>carbon.heap.memory.pooling.threshold.bytes</td>
<td>1048576</td>
-<td>CarbonData supports unsafe operations of Java to avoid GC overhead for certain operations.Using unsafe, memory can be allocated on Java Heap or off heap.This configuration controlls the allocation mechanism on Java HEAP.If the heap memory allocations of the given size is greater or equal than this value,it should go through the pooling mechanism.But if set this size to -1, it should not go through the pooling mechanism.Default value is 1048576(1MB, the same as Spark).Value to be specified in bytes.</td>
+<td>CarbonData supports unsafe operations of Java to avoid GC overhead for certain operations. Using unsafe, memory can be allocated on Java Heap or off heap. This configuration controls the allocation mechanism on Java HEAP.If the heap memory allocations of the given size is greater or equal than this value,it should go through the pooling mechanism.But if set this size to -1, it should not go through the pooling mechanism.Default value is 1048576(1MB, the same as Spark).Value to be specified in bytes.</td>
</tr>
</tbody>
</table>
@@ -747,7 +770,7 @@
<tr>
<td>carbon.insert.storage.level</td>
<td>MEMORY_AND_DISK</td>
-<td>Storage level to persist dataset of a RDD/dataframe.Applicable when <em><strong>carbon.insert.persist.enable</strong></em> is <strong>true</strong>, if user's executor has less memory, set this parameter to 'MEMORY_AND_DISK_SER' or other storage level to correspond to different environment. <a href="http://spark.apache.org/docs/latest/rdd-programming-guide.html#rdd-persistence" rel="nofollow">See detail</a>.</td>
+<td>Storage level to persist dataset of a RDD/dataframe. Applicable when <em><strong>carbon.insert.persist.enable</strong></em> is <strong>true</strong>, if user's executor has less memory, set this parameter to 'MEMORY_AND_DISK_SER' or other storage level to correspond to different environment. <a href="http://spark.apache.org/docs/latest/rdd-programming-guide.html#rdd-persistence" rel="nofollow">See detail</a>.</td>
</tr>
<tr>
<td>carbon.update.persist.enable</td>
@@ -757,7 +780,7 @@
<tr>
<td>carbon.update.storage.level</td>
<td>MEMORY_AND_DISK</td>
-<td>Storage level to persist dataset of a RDD/dataframe.Applicable when <em><strong>carbon.update.persist.enable</strong></em> is <strong>true</strong>, if user's executor has less memory, set this parameter to 'MEMORY_AND_DISK_SER' or other storage level to correspond to different environment. <a href="http://spark.apache.org/docs/latest/rdd-programming-guide.html#rdd-persistence" rel="nofollow">See detail</a>.</td>
+<td>Storage level to persist dataset of a RDD/dataframe. Applicable when <em><strong>carbon.update.persist.enable</strong></em> is <strong>true</strong>, if user's executor has less memory, set this parameter to 'MEMORY_AND_DISK_SER' or other storage level to correspond to different environment. <a href="http://spark.apache.org/docs/latest/rdd-programming-guide.html#rdd-persistence" rel="nofollow">See detail</a>.</td>
</tr>
</tbody>
</table>
@@ -821,7 +844,7 @@
<tbody>
<tr>
<td>carbon.options.bad.records.logger.enable</td>
-<td>CarbonData can identify the records that are not conformant to schema and isolate them as bad records.Enabling this configuration will make CarbonData to log such bad records.<strong>NOTE:</strong> If the input data contains many bad records, logging them will slow down the over all data loading throughput.The data load operation status would depend on the configuration in <em><strong>carbon.bad.records.action</strong></em>.</td>
+<td>CarbonData can identify the records that are not conformant to schema and isolate them as bad records.Enabling this configuration will make CarbonData to log such bad records.<strong>NOTE:</strong> If the input data contains many bad records, logging them will slow down the over all data loading throughput. The data load operation status would depend on the configuration in <em><strong>carbon.bad.records.action</strong></em>.</td>
</tr>
<tr>
<td>carbon.options.bad.records.logger.enable</td>
@@ -841,7 +864,7 @@
</tr>
<tr>
<td>carbon.options.single.pass</td>
-<td>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. This option specifies whether to use single pass for loading data or not. By default this option is set to FALSE.<strong>NOTE:</strong> Enabling this starts a new dictionary server to handle dictionary generation requests during data loading.Without this option, the input csv files will have to read twice.Once while dictionary generation and persisting to the dictionary files.second when the data loading need to convert the input data into carbondata format.Enabling this optimizes the optimizes to read the input data only once there by reducing IO and hence over all data loading time.If concurrent data loading needs to be supported, consider tuning <em><strong>dictionar
<TRUNCATED>
[04/20] carbondata-site git commit: modified for 1.5.0 version
Posted by ch...@apache.org.
http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6ad7599a/src/main/webapp/quick-start-guide.html
----------------------------------------------------------------------
diff --git a/src/main/webapp/quick-start-guide.html b/src/main/webapp/quick-start-guide.html
index f3e8a8f..8e599d3 100644
--- a/src/main/webapp/quick-start-guide.html
+++ b/src/main/webapp/quick-start-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>
@@ -212,7 +220,7 @@
<div>
<h1>
<a id="quick-start" class="anchor" href="#quick-start" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Quick Start</h1>
-<p>This tutorial provides a quick introduction to using CarbonData.To follow along with this guide, first download a packaged release of CarbonData from the <a href="https://dist.apache.org/repos/dist/release/carbondata/" target=_blank rel="nofollow">CarbonData website</a>.Alternatively it can be created following <a href="https://github.com/apache/carbondata/tree/master/build" target=_blank>Building CarbonData</a> steps.</p>
+<p>This tutorial provides a quick introduction to using CarbonData. To follow along with this guide, first download a packaged release of CarbonData from the <a href="https://dist.apache.org/repos/dist/release/carbondata/" target=_blank rel="nofollow">CarbonData website</a>.Alternatively it can be created following <a href="https://github.com/apache/carbondata/tree/master/build" target=_blank>Building CarbonData</a> steps.</p>
<h2>
<a id="prerequisites" class="anchor" href="#prerequisites" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Prerequisites</h2>
<ul>
@@ -233,7 +241,7 @@ EOF
</ul>
<h2>
<a id="integration" class="anchor" href="#integration" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Integration</h2>
-<p>CarbonData can be integrated with Spark and Presto Execution Engines.The below documentation guides on Installing and Configuring with these execution engines.</p>
+<p>CarbonData can be integrated with Spark and Presto Execution Engines. The below documentation guides on Installing and Configuring with these execution engines.</p>
<h3>
<a id="spark" class="anchor" href="#spark" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Spark</h3>
<p><a href="#installing-and-configuring-carbondata-to-run-locally-with-spark-shell">Installing and Configuring CarbonData to run locally with Spark Shell</a></p>
@@ -555,26 +563,26 @@ hdfs://<host_name>:port/user/hive/warehouse/carbon.store
</code></pre>
<h2>
<a id="installing-and-configuring-carbondata-on-presto" class="anchor" href="#installing-and-configuring-carbondata-on-presto" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Installing and Configuring CarbonData on Presto</h2>
-<p><strong>NOTE:</strong> <strong>CarbonData tables cannot be created nor loaded from Presto.User need to create CarbonData Table and load data into it
+<p><strong>NOTE:</strong> <strong>CarbonData tables cannot be created nor loaded from Presto. User need to create CarbonData Table and load data into it
either with <a href="#installing-and-configuring-carbondata-to-run-locally-with-spark-shell">Spark</a> or <a href="./sdk-guide.html">SDK</a>.
Once the table is created,it can be queried from Presto.</strong></p>
<h3>
<a id="installing-presto" class="anchor" href="#installing-presto" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Installing Presto</h3>
<ol>
<li>
-<p>Download the 0.187 version of Presto using:
-<code>wget https://repo1.maven.org/maven2/com/facebook/presto/presto-server/0.187/presto-server-0.187.tar.gz</code></p>
+<p>Download the 0.210 version of Presto using:
+<code>wget https://repo1.maven.org/maven2/com/facebook/presto/presto-server/0.210/presto-server-0.210.tar.gz</code></p>
</li>
<li>
-<p>Extract Presto tar file: <code>tar zxvf presto-server-0.187.tar.gz</code>.</p>
+<p>Extract Presto tar file: <code>tar zxvf presto-server-0.210.tar.gz</code>.</p>
</li>
<li>
<p>Download the Presto CLI for the coordinator and name it presto.</p>
</li>
</ol>
-<pre><code> wget https://repo1.maven.org/maven2/com/facebook/presto/presto-cli/0.187/presto-cli-0.187-executable.jar
+<pre><code> wget https://repo1.maven.org/maven2/com/facebook/presto/presto-cli/0.210/presto-cli-0.210-executable.jar
- mv presto-cli-0.187-executable.jar presto
+ mv presto-cli-0.210-executable.jar presto
chmod +x presto
</code></pre>
@@ -582,7 +590,7 @@ Once the table is created,it can be queried from Presto.</strong></p>
<a id="create-configuration-files" class="anchor" href="#create-configuration-files" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Create Configuration Files</h3>
<ol>
<li>
-<p>Create <code>etc</code> folder in presto-server-0.187 directory.</p>
+<p>Create <code>etc</code> folder in presto-server-0.210 directory.</p>
</li>
<li>
<p>Create <code>config.properties</code>, <code>jvm.config</code>, <code>log.properties</code>, and <code>node.properties</code> files.</p>
@@ -624,10 +632,15 @@ node.data-dir=/home/ubuntu/data
<pre><code>coordinator=true
node-scheduler.include-coordinator=false
http-server.http.port=8086
-query.max-memory=50GB
-query.max-memory-per-node=2GB
+query.max-memory=5GB
+query.max-total-memory-per-node=5GB
+query.max-memory-per-node=3GB
+memory.heap-headroom-per-node=1GB
discovery-server.enabled=true
-discovery.uri=<coordinator_ip>:8086
+discovery.uri=http://localhost:8086
+task.max-worker-threads=4
+optimizer.dictionary-aggregation=true
+optimizer.optimize-hash-generation = false
</code></pre>
<p>The options <code>node-scheduler.include-coordinator=false</code> and <code>coordinator=true</code> indicate that the node is the coordinator and tells the coordinator not to do any of the computation work itself and to use the workers.</p>
<p><strong>Note</strong>: It is recommended to set <code>query.max-memory-per-node</code> to half of the JVM config max memory, though the workload is highly concurrent, lower value for <code>query.max-memory-per-node</code> is to be used.</p>
@@ -640,7 +653,7 @@ Then, <code>query.max-memory=<30GB * number of nodes></code>.</p>
<a id="contents-of-your-configproperties-1" class="anchor" href="#contents-of-your-configproperties-1" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Contents of your config.properties</h5>
<pre><code>coordinator=false
http-server.http.port=8086
-query.max-memory=50GB
+query.max-memory=5GB
query.max-memory-per-node=2GB
discovery.uri=<coordinator_ip>:8086
</code></pre>
@@ -663,10 +676,10 @@ discovery.uri=<coordinator_ip>:8086
</ol>
<h3>
<a id="start-presto-server-on-all-nodes" class="anchor" href="#start-presto-server-on-all-nodes" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Start Presto Server on all nodes</h3>
-<pre><code>./presto-server-0.187/bin/launcher start
+<pre><code>./presto-server-0.210/bin/launcher start
</code></pre>
<p>To run it as a background process.</p>
-<pre><code>./presto-server-0.187/bin/launcher run
+<pre><code>./presto-server-0.210/bin/launcher run
</code></pre>
<p>To run it in foreground.</p>
<h3>
http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6ad7599a/src/main/webapp/release-guide.html
----------------------------------------------------------------------
diff --git a/src/main/webapp/release-guide.html b/src/main/webapp/release-guide.html
index cb47540..891d897 100644
--- a/src/main/webapp/release-guide.html
+++ b/src/main/webapp/release-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>
http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6ad7599a/src/main/webapp/s3-guide.html
----------------------------------------------------------------------
diff --git a/src/main/webapp/s3-guide.html b/src/main/webapp/s3-guide.html
index 57af913..62c51c3 100644
--- a/src/main/webapp/s3-guide.html
+++ b/src/main/webapp/s3-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>
@@ -211,7 +219,7 @@
<div class="col-sm-12 col-md-12">
<div>
<h1>
-<a id="s3-guide-alpha-feature-141" class="anchor" href="#s3-guide-alpha-feature-141" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>S3 Guide (Alpha Feature 1.4.1)</h1>
+<a id="s3-guide" class="anchor" href="#s3-guide" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>S3 Guide</h1>
<p>Object storage is the recommended storage format in cloud as it can support storing large data
files. S3 APIs are widely used for accessing object stores. This can be
used to store or retrieve data on Amazon cloud, Huawei Cloud(OBS) or on any other object
http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6ad7599a/src/main/webapp/sdk-guide.html
----------------------------------------------------------------------
diff --git a/src/main/webapp/sdk-guide.html b/src/main/webapp/sdk-guide.html
index a252965..5ddf9f7 100644
--- a/src/main/webapp/sdk-guide.html
+++ b/src/main/webapp/sdk-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>
@@ -259,9 +267,9 @@ These SDK writer output contains just a carbondata and carbonindex files. No met
<span class="pl-smi">CarbonProperties</span><span class="pl-k">.</span>getInstance()<span class="pl-k">.</span>addProperty(<span class="pl-s"><span class="pl-pds">"</span>enable.offheap.sort<span class="pl-pds">"</span></span>, enableOffheap);
- <span class="pl-smi">CarbonWriterBuilder</span> builder <span class="pl-k">=</span> <span class="pl-smi">CarbonWriter</span><span class="pl-k">.</span>builder()<span class="pl-k">.</span>outputPath(path);
+ <span class="pl-smi">CarbonWriterBuilder</span> builder <span class="pl-k">=</span> <span class="pl-smi">CarbonWriter</span><span class="pl-k">.</span>builder()<span class="pl-k">.</span>outputPath(path)<span class="pl-k">.</span>withCsvInput(schema);
- <span class="pl-smi">CarbonWriter</span> writer <span class="pl-k">=</span> builder<span class="pl-k">.</span>buildWriterForCSVInput(schema);
+ <span class="pl-smi">CarbonWriter</span> writer <span class="pl-k">=</span> builder<span class="pl-k">.</span>build();
<span class="pl-k">int</span> rows <span class="pl-k">=</span> <span class="pl-c1">5</span>;
<span class="pl-k">for</span> (<span class="pl-k">int</span> i <span class="pl-k">=</span> <span class="pl-c1">0</span>; i <span class="pl-k"><</span> rows; i<span class="pl-k">++</span>) {
@@ -314,7 +322,7 @@ These SDK writer output contains just a carbondata and carbonindex files. No met
<span class="pl-k">try</span> {
<span class="pl-smi">CarbonWriter</span> writer <span class="pl-k">=</span> <span class="pl-smi">CarbonWriter</span><span class="pl-k">.</span>builder()
.outputPath(path)
- .buildWriterForAvroInput(<span class="pl-k">new</span> <span class="pl-smi">org.apache.avro<span class="pl-k">.</span>Schema</span>.<span class="pl-smi">Parser</span>()<span class="pl-k">.</span>parse(avroSchema));
+ .withAvroInput(<span class="pl-k">new</span> <span class="pl-smi">org.apache.avro<span class="pl-k">.</span>Schema</span>.<span class="pl-smi">Parser</span>()<span class="pl-k">.</span>parse(avroSchema))<span class="pl-k">.</span>build();
<span class="pl-k">for</span> (<span class="pl-k">int</span> i <span class="pl-k">=</span> <span class="pl-c1">0</span>; i <span class="pl-k"><</span> <span class="pl-c1">100</span>; i<span class="pl-k">++</span>) {
writer<span class="pl-k">.</span>write(record);
@@ -352,10 +360,10 @@ These SDK writer output contains just a carbondata and carbonindex files. No met
<span class="pl-smi">Schema</span> <span class="pl-smi">CarbonSchema</span> <span class="pl-k">=</span> <span class="pl-k">new</span> <span class="pl-smi">Schema</span>(fields);
- <span class="pl-smi">CarbonWriterBuilder</span> builder <span class="pl-k">=</span> <span class="pl-smi">CarbonWriter</span><span class="pl-k">.</span>builder()<span class="pl-k">.</span>outputPath(path);
+ <span class="pl-smi">CarbonWriterBuilder</span> builder <span class="pl-k">=</span> <span class="pl-smi">CarbonWriter</span><span class="pl-k">.</span>builder()<span class="pl-k">.</span>outputPath(path)<span class="pl-k">.</span>withJsonInput(<span class="pl-smi">CarbonSchema</span>);
<span class="pl-c"><span class="pl-c">//</span> initialize json writer with carbon schema</span>
- <span class="pl-smi">CarbonWriter</span> writer <span class="pl-k">=</span> builder<span class="pl-k">.</span>buildWriterForJsonInput(<span class="pl-smi">CarbonSchema</span>);
+ <span class="pl-smi">CarbonWriter</span> writer <span class="pl-k">=</span> builder<span class="pl-k">.</span>build();
<span class="pl-c"><span class="pl-c">//</span> one row of json Data as String</span>
<span class="pl-smi">String</span> <span class="pl-smi">JsonRow</span> <span class="pl-k">=</span> <span class="pl-s"><span class="pl-pds">"</span>{<span class="pl-cce">\"</span>name<span class="pl-cce">\"</span>:<span class="pl-cce">\"</span>abcd<span class="pl-cce">\"</span>, <span class="pl-cce">\"</span>age<span class="pl-cce">\"</span>:10}<span class="pl-pds">"</span></span>;
@@ -368,59 +376,127 @@ These SDK writer output contains just a carbondata and carbonindex files. No met
} </pre></div>
<h2>
<a id="datatypes-mapping" class="anchor" href="#datatypes-mapping" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Datatypes Mapping</h2>
-<p>Each of SQL data types are mapped into data types of SDK. Following are the mapping:</p>
+<p>Each of SQL data types and Avro Data Types are mapped into data types of SDK. Following are the mapping:</p>
<table>
<thead>
<tr>
<th>SQL DataTypes</th>
+<th>Avro DataTypes</th>
<th>Mapped SDK DataTypes</th>
</tr>
</thead>
<tbody>
<tr>
<td>BOOLEAN</td>
+<td>BOOLEAN</td>
<td>DataTypes.BOOLEAN</td>
</tr>
<tr>
<td>SMALLINT</td>
+<td>-</td>
<td>DataTypes.SHORT</td>
</tr>
<tr>
<td>INTEGER</td>
+<td>INTEGER</td>
<td>DataTypes.INT</td>
</tr>
<tr>
<td>BIGINT</td>
+<td>LONG</td>
<td>DataTypes.LONG</td>
</tr>
<tr>
<td>DOUBLE</td>
+<td>DOUBLE</td>
<td>DataTypes.DOUBLE</td>
</tr>
<tr>
<td>VARCHAR</td>
+<td>-</td>
<td>DataTypes.STRING</td>
</tr>
<tr>
+<td>FLOAT</td>
+<td>FLOAT</td>
+<td>DataTypes.FLOAT</td>
+</tr>
+<tr>
+<td>BYTE</td>
+<td>-</td>
+<td>DataTypes.BYTE</td>
+</tr>
+<tr>
+<td>DATE</td>
<td>DATE</td>
<td>DataTypes.DATE</td>
</tr>
<tr>
<td>TIMESTAMP</td>
+<td>-</td>
<td>DataTypes.TIMESTAMP</td>
</tr>
<tr>
<td>STRING</td>
+<td>STRING</td>
<td>DataTypes.STRING</td>
</tr>
<tr>
<td>DECIMAL</td>
+<td>DECIMAL</td>
<td>DataTypes.createDecimalType(precision, scale)</td>
</tr>
+<tr>
+<td>ARRAY</td>
+<td>ARRAY</td>
+<td>DataTypes.createArrayType(elementType)</td>
+</tr>
+<tr>
+<td>STRUCT</td>
+<td>RECORD</td>
+<td>DataTypes.createStructType(fields)</td>
+</tr>
+<tr>
+<td>-</td>
+<td>ENUM</td>
+<td>DataTypes.STRING</td>
+</tr>
+<tr>
+<td>-</td>
+<td>UNION</td>
+<td>DataTypes.createStructType(types)</td>
+</tr>
+<tr>
+<td>-</td>
+<td>MAP</td>
+<td>DataTypes.createMapType(keyType, valueType)</td>
+</tr>
+<tr>
+<td>-</td>
+<td>TimeMillis</td>
+<td>DataTypes.INT</td>
+</tr>
+<tr>
+<td>-</td>
+<td>TimeMicros</td>
+<td>DataTypes.LONG</td>
+</tr>
+<tr>
+<td>-</td>
+<td>TimestampMillis</td>
+<td>DataTypes.TIMESTAMP</td>
+</tr>
+<tr>
+<td>-</td>
+<td>TimestampMicros</td>
+<td>DataTypes.TIMESTAMP</td>
+</tr>
</tbody>
</table>
-<p><strong>NOTE:</strong>
-Carbon Supports below logical types of AVRO.
+<p><strong>NOTE:</strong></p>
+<ol>
+<li>
+<p>Carbon Supports below logical types of AVRO.
a. Date
The date logical type represents a date within the calendar, with no reference to a particular time zone or time of day.
A date logical type annotates an Avro int, where the int stores the number of days from the unix epoch, 1 January 1970 (ISO calendar).
@@ -429,10 +505,27 @@ The timestamp-millis logical type represents an instant on the global timeline,
A timestamp-millis logical type annotates an Avro long, where the long stores the number of milliseconds from the unix epoch, 1 January 1970 00:00:00.000 UTC.
c. Timestamp (microsecond precision)
The timestamp-micros logical type represents an instant on the global timeline, independent of a particular time zone or calendar, with a precision of one microsecond.
-A timestamp-micros logical type annotates an Avro long, where the long stores the number of microseconds from the unix epoch, 1 January 1970 00:00:00.000000 UTC.</p>
-<pre><code>Currently the values of logical types are not validated by carbon.
-Expect that avro record passed by the user is already validated by avro record generator tools.
-</code></pre>
+A timestamp-micros logical type annotates an Avro long, where the long stores the number of microseconds from the unix epoch, 1 January 1970 00:00:00.000000 UTC.
+d. Decimal
+The decimal logical type represents an arbitrary-precision signed decimal number of the form unscaled � 10-scale.
+A decimal logical type annotates Avro bytes or fixed types. The byte array must contain the two's-complement representation of the unscaled integer value in big-endian byte order. The scale is fixed, and is specified using an attribute.
+e. Time (millisecond precision)
+The time-millis logical type represents a time of day, with no reference to a particular calendar, time zone or date, with a precision of one millisecond.
+A time-millis logical type annotates an Avro int, where the int stores the number of milliseconds after midnight, 00:00:00.000.
+f. Time (microsecond precision)
+The time-micros logical type represents a time of day, with no reference to a particular calendar, time zone or date, with a precision of one microsecond.
+A time-micros logical type annotates an Avro long, where the long stores the number of microseconds after midnight, 00:00:00.000000.</p>
+<p>Currently the values of logical types are not validated by carbon.
+Expect that avro record passed by the user is already validated by avro record generator tools.</p>
+</li>
+<li>
+<p>If the string data is more than 32K in length, use withTableProperties() with "long_string_columns" property
+or directly use DataTypes.VARCHAR if it is carbon schema.</p>
+</li>
+<li>
+<p>Avro Bytes, Fixed and Duration data types are not yet supported.</p>
+</li>
+</ol>
<h2>
<a id="run-sql-on-files-directly" class="anchor" href="#run-sql-on-files-directly" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Run SQL on files directly</h2>
<p>Instead of creating table and query it, you can also query that file directly with SQL.</p>
@@ -454,18 +547,6 @@ Expect that avro record passed by the user is already validated by avro record g
public CarbonWriterBuilder outputPath(String path);
</code></pre>
<pre><code>/**
-* If set false, writes the carbondata and carbonindex files in a flat folder structure
-* @param isTransactionalTable is a boolelan value
-* if set to false, then writes the carbondata and carbonindex files
-* in a flat folder structure.
-* if set to true, then writes the carbondata and carbonindex files
-* in segment folder structure..
-* By default set to false.
-* @return updated CarbonWriterBuilder
-*/
-public CarbonWriterBuilder isTransactionalTable(boolean isTransactionalTable);
-</code></pre>
-<pre><code>/**
* to set the timestamp in the carbondata and carbonindex index files
* @param UUID is a timestamp to be used in the carbondata and carbonindex index files.
* By default set to zero.
@@ -511,14 +592,6 @@ public CarbonWriterBuilder localDictionaryThreshold(int localDictionaryThreshold
public CarbonWriterBuilder sortBy(String[] sortColumns);
</code></pre>
<pre><code>/**
-* If set, create a schema file in metadata folder.
-* @param persist is a boolean value, If set to true, creates a schema file in metadata folder.
-* By default set to false. will not create metadata folder
-* @return updated CarbonWriterBuilder
-*/
-public CarbonWriterBuilder persistSchemaFile(boolean persist);
-</code></pre>
-<pre><code>/**
* sets the taskNo for the writer. SDKs concurrently running
* will set taskNo in order to avoid conflicts in file's name during write.
* @param taskNo is the TaskNo user wants to specify.
@@ -540,7 +613,7 @@ public CarbonWriterBuilder taskNo(long taskNo);
* g. complex_delimiter_level_2 -- value to Split the nested complexTypeData
* h. quotechar
* i. escapechar
-*
+*
* Default values are as follows.
*
* a. bad_records_logger_enable -- "false"
@@ -558,84 +631,76 @@ public CarbonWriterBuilder taskNo(long taskNo);
public CarbonWriterBuilder withLoadOptions(Map<String, String> options);
</code></pre>
<pre><code>/**
- * To support the table properties for sdk writer
- *
- * @param options key,value pair of create table properties.
- * supported keys values are
- * a. blocksize -- [1-2048] values in MB. Default value is 1024
- * b. blockletsize -- values in MB. Default value is 64 MB
- * c. localDictionaryThreshold -- positive value, default is 10000
- * d. enableLocalDictionary -- true / false. Default is false
- * e. sortcolumns -- comma separated column. "c1,c2". Default all dimensions are sorted.
- *
- * @return updated CarbonWriterBuilder
- */
+* To support the table properties for sdk writer
+*
+* @param options key,value pair of create table properties.
+* supported keys values are
+* a. table_blocksize -- [1-2048] values in MB. Default value is 1024
+* b. table_blocklet_size -- values in MB. Default value is 64 MB
+* c. local_dictionary_threshold -- positive value, default is 10000
+* d. local_dictionary_enable -- true / false. Default is false
+* e. sort_columns -- comma separated column. "c1,c2". Default all dimensions are sorted.
+ If empty string "" is passed. No columns are sorted
+* j. sort_scope -- "local_sort", "no_sort", "batch_sort". default value is "local_sort"
+* k. long_string_columns -- comma separated string columns which are more than 32k length.
+* default value is null.
+*
+* @return updated CarbonWriterBuilder
+*/
public CarbonWriterBuilder withTableProperties(Map<String, String> options);
</code></pre>
<pre><code>/**
-* this writer is not thread safe, use buildThreadSafeWriterForCSVInput in multi thread environment
-* Build a {@link CarbonWriter}, which accepts row in CSV format object
-* @param schema carbon Schema object {org.apache.carbondata.sdk.file.Schema}
-* @return CSVCarbonWriter
-* @throws IOException
-* @throws InvalidLoadOptionException
+* To make sdk writer thread safe.
+*
+* @param numOfThreads should number of threads in which writer is called in multi-thread scenario
+* default sdk writer is not thread safe.
+* can use one writer instance in one thread only.
+* @return updated CarbonWriterBuilder
*/
-public CarbonWriter buildWriterForCSVInput(org.apache.carbondata.sdk.file.Schema schema) throws IOException, InvalidLoadOptionException;
+public CarbonWriterBuilder withThreadSafe(short numOfThreads);
</code></pre>
<pre><code>/**
-* Can use this writer in multi-thread instance.
-* Build a {@link CarbonWriter}, which accepts row in CSV format
-* @param schema carbon Schema object {org.apache.carbondata.sdk.file.Schema}
-* @param numOfThreads number of threads() in which .write will be called.
-* @return CSVCarbonWriter
-* @throws IOException
-* @throws InvalidLoadOptionException
+* To support hadoop configuration
+*
+* @param conf hadoop configuration support, can set s3a AK,SK,end point and other conf with this
+* @return updated CarbonWriterBuilder
*/
-public CarbonWriter buildThreadSafeWriterForCSVInput(Schema schema, short numOfThreads)
- throws IOException, InvalidLoadOptionException;
+public CarbonWriterBuilder withHadoopConf(Configuration conf)
</code></pre>
<pre><code>/**
-* this writer is not thread safe, use buildThreadSafeWriterForAvroInput in multi thread environment
-* Build a {@link CarbonWriter}, which accepts Avro format object
-* @param avroSchema avro Schema object {org.apache.avro.Schema}
-* @return AvroCarbonWriter
-* @throws IOException
-* @throws InvalidLoadOptionException
+* to build a {@link CarbonWriter}, which accepts row in CSV format
+*
+* @param schema carbon Schema object {org.apache.carbondata.sdk.file.Schema}
+* @return CarbonWriterBuilder
*/
-public CarbonWriter buildWriterForAvroInput(org.apache.avro.Schema schema) throws IOException, InvalidLoadOptionException;
+public CarbonWriterBuilder withCsvInput(Schema schema);
</code></pre>
<pre><code>/**
-* Can use this writer in multi-thread instance.
-* Build a {@link CarbonWriter}, which accepts Avro object
+* to build a {@link CarbonWriter}, which accepts Avro object
+*
* @param avroSchema avro Schema object {org.apache.avro.Schema}
-* @param numOfThreads number of threads() in which .write will be called.
-* @return AvroCarbonWriter
-* @throws IOException
-* @throws InvalidLoadOptionException
+* @return CarbonWriterBuilder
*/
-public CarbonWriter buildThreadSafeWriterForAvroInput(org.apache.avro.Schema avroSchema, short numOfThreads)
- throws IOException, InvalidLoadOptionException
+public CarbonWriterBuilder withAvroInput(org.apache.avro.Schema avroSchema);
</code></pre>
<pre><code>/**
-* this writer is not thread safe, use buildThreadSafeWriterForJsonInput in multi thread environment
-* Build a {@link CarbonWriter}, which accepts Json object
+* to build a {@link CarbonWriter}, which accepts Json object
+*
* @param carbonSchema carbon Schema object
-* @return JsonCarbonWriter
-* @throws IOException
-* @throws InvalidLoadOptionException
+* @return CarbonWriterBuilder
*/
-public JsonCarbonWriter buildWriterForJsonInput(Schema carbonSchema);
+public CarbonWriterBuilder withJsonInput(Schema carbonSchema);
</code></pre>
<pre><code>/**
-* Can use this writer in multi-thread instance.
-* Build a {@link CarbonWriter}, which accepts Json object
-* @param carbonSchema carbon Schema object
-* @param numOfThreads number of threads() in which .write will be called.
-* @return JsonCarbonWriter
+* Build a {@link CarbonWriter}
+* This writer is not thread safe,
+* use withThreadSafe() configuration in multi thread environment
+*
+* @return CarbonWriter {AvroCarbonWriter/CSVCarbonWriter/JsonCarbonWriter based on Input Type }
* @throws IOException
* @throws InvalidLoadOptionException
*/
-public JsonCarbonWriter buildThreadSafeWriterForJsonInput(Schema carbonSchema, short numOfThreads)
+public CarbonWriter build() throws IOException, InvalidLoadOptionException;
</code></pre>
<h3>
<a id="class-orgapachecarbondatasdkfilecarbonwriter" class="anchor" href="#class-orgapachecarbondatasdkfilecarbonwriter" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Class org.apache.carbondata.sdk.file.CarbonWriter</h3>
@@ -645,7 +710,6 @@ public JsonCarbonWriter buildThreadSafeWriterForJsonInput(Schema carbonSchema, s
* which is one row of data.
* If CSVCarbonWriter, object is of type String[], which is one row of data
* If JsonCarbonWriter, object is of type String, which is one row of json
-* Note: This API is not thread safe if writer is not built with number of threads argument.
* @param object
* @throws IOException
*/
@@ -793,17 +857,6 @@ External client can make use of this reader to read CarbonData files without Car
*/
public CarbonReaderBuilder projection(String[] projectionColumnNames);
</code></pre>
-<pre><code> /**
- * Configure the transactional status of table
- * If set to false, then reads the carbondata and carbonindex files from a flat folder structure.
- * If set to true, then reads the carbondata and carbonindex files from segment folder structure.
- * Default value is false
- *
- * @param isTransactionalTable whether is transactional table or not
- * @return CarbonReaderBuilder object
- */
- public CarbonReaderBuilder isTransactionalTable(boolean isTransactionalTable);
-</code></pre>
<pre><code> /**
* Configure the filter expression for carbon reader
*
@@ -812,56 +865,13 @@ External client can make use of this reader to read CarbonData files without Car
*/
public CarbonReaderBuilder filter(Expression filterExpression);
</code></pre>
-<pre><code> /**
- * Set the access key for S3
- *
- * @param key the string of access key for different S3 type,like: fs.s3a.access.key
- * @param value the value of access key
- * @return CarbonWriterBuilder
- */
- public CarbonReaderBuilder setAccessKey(String key, String value);
-</code></pre>
-<pre><code> /**
- * Set the access key for S3.
- *
- * @param value the value of access key
- * @return CarbonWriterBuilder object
- */
- public CarbonReaderBuilder setAccessKey(String value);
-</code></pre>
-<pre><code> /**
- * Set the secret key for S3
- *
- * @param key the string of secret key for different S3 type,like: fs.s3a.secret.key
- * @param value the value of secret key
- * @return CarbonWriterBuilder object
- */
- public CarbonReaderBuilder setSecretKey(String key, String value);
-</code></pre>
-<pre><code> /**
- * Set the secret key for S3
- *
- * @param value the value of secret key
- * @return CarbonWriterBuilder object
- */
- public CarbonReaderBuilder setSecretKey(String value);
-</code></pre>
-<pre><code> /**
- * Set the endpoint for S3
- *
- * @param key the string of endpoint for different S3 type,like: fs.s3a.endpoint
- * @param value the value of endpoint
- * @return CarbonWriterBuilder object
- */
- public CarbonReaderBuilder setEndPoint(String key, String value);
-</code></pre>
-<pre><code> /**
- * Set the endpoint for S3
- *
- * @param value the value of endpoint
- * @return CarbonWriterBuilder object
- */
- public CarbonReaderBuilder setEndPoint(String value);
+<pre><code>/**
+ * To support hadoop configuration
+ *
+ * @param conf hadoop configuration support, can set s3a AK,SK,end point and other conf with this
+ * @return updated CarbonReaderBuilder
+ */
+ public CarbonReaderBuilder withHadoopConf(Configuration conf);
</code></pre>
<pre><code> /**
* Build CarbonReader
@@ -992,8 +1002,15 @@ public String getProperty(String key, String defaultValue);
</code></pre>
<p>Reference : <a href="./configuration-parameters.html">list of carbon properties</a></p>
<script>
-// Show selected style on nav item
-$(function() { $('.b-nav__api').addClass('selected'); });
+$(function() {
+ // Show selected style on nav item
+ $('.b-nav__api').addClass('selected');
+
+ if (!$('.b-nav__api').parent().hasClass('nav__item__with__subs--expanded')) {
+ // Display api subnav items
+ $('.b-nav__api').parent().toggleClass('nav__item__with__subs--expanded');
+ }
+});
</script></div>
</div>
</div>
http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6ad7599a/src/main/webapp/segment-management-on-carbondata.html
----------------------------------------------------------------------
diff --git a/src/main/webapp/segment-management-on-carbondata.html b/src/main/webapp/segment-management-on-carbondata.html
index 1e6f61d..1d70f24 100644
--- a/src/main/webapp/segment-management-on-carbondata.html
+++ b/src/main/webapp/segment-management-on-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>
http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6ad7599a/src/main/webapp/streaming-guide.html
----------------------------------------------------------------------
diff --git a/src/main/webapp/streaming-guide.html b/src/main/webapp/streaming-guide.html
index 86f0385..e82b84a 100644
--- a/src/main/webapp/streaming-guide.html
+++ b/src/main/webapp/streaming-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>
@@ -360,7 +368,7 @@ streaming table using following DDL.</p>
<p>At the begin of streaming ingestion, the system will try to acquire the table level lock of streaming.lock file. If the system isn't able to acquire the lock of this table, it will throw an InterruptedException.</p>
<h2>
<a id="create-streaming-segment" class="anchor" href="#create-streaming-segment" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Create streaming segment</h2>
-<p>The input data of streaming will be ingested into a segment of the CarbonData table, the status of this segment is streaming. CarbonData call it a streaming segment. The "tablestatus" file will record the segment status and data size. The user can use ?SHOW SEGMENTS FOR TABLE tableName? to check segment status.</p>
+<p>The streaming data will be ingested into a separate segment of carbondata table, this segment is termed as streaming segment. The status of this segment will be recorded as "streaming" in "tablestatus" file along with its data size. You can use "SHOW SEGMENTS FOR TABLE tableName" to check segment status.</p>
<p>After the streaming segment reaches the max size, CarbonData will change the segment status to "streaming finish" from "streaming", and create new "streaming" segment to continue to ingest streaming data.</p>
<table>
<thead>
@@ -533,8 +541,9 @@ streaming table using following DDL.</p>
| register TIMESTAMP,
| updated TIMESTAMP
|)
- |STORED BY carbondata
+ |STORED AS carbondata
|TBLPROPERTIES (
+ | 'streaming'='source',
| 'format'='csv',
| 'path'='$csvDataDir'
|)
@@ -553,7 +562,7 @@ streaming table using following DDL.</p>
| register TIMESTAMP,
| updated TIMESTAMP
|)
- |STORED BY carbondata
+ |STORED AS carbondata
|TBLPROPERTIES (
| 'streaming'='true'
|)
@@ -576,7 +585,7 @@ streaming table using following DDL.</p>
sql("SHOW STREAMS [ON TABLE tableName]")
</code></pre>
<p>In above example, two table is created: source and sink. The <code>source</code> table's format is <code>csv</code> and <code>sink</code> table format is <code>carbon</code>. Then a streaming job is created to stream data from source table to sink table.</p>
-<p>These two tables are normal carbon table, they can be queried independently.</p>
+<p>These two tables are normal carbon tables, they can be queried independently.</p>
<h3>
<a id="streaming-job-management" class="anchor" href="#streaming-job-management" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Streaming Job Management</h3>
<p>As above example shown:</p>
@@ -601,18 +610,22 @@ streaming table using following DDL.</p>
name STRING,
age <span class="pl-k">INT</span>
)
-STORED BY carbondata
+STORED <span class="pl-k">AS</span> carbondata
TBLPROPERTIES(
- <span class="pl-s"><span class="pl-pds">'</span>format<span class="pl-pds">'</span></span><span class="pl-k">=</span><span class="pl-s"><span class="pl-pds">'</span>socket<span class="pl-pds">'</span></span>,
- <span class="pl-s"><span class="pl-pds">'</span>host<span class="pl-pds">'</span></span><span class="pl-k">=</span><span class="pl-s"><span class="pl-pds">'</span>localhost<span class="pl-pds">'</span></span>,
- <span class="pl-s"><span class="pl-pds">'</span>port<span class="pl-pds">'</span></span><span class="pl-k">=</span><span class="pl-s"><span class="pl-pds">'</span>8888<span class="pl-pds">'</span></span>
+ <span class="pl-s"><span class="pl-pds">'</span>streaming<span class="pl-pds">'</span></span><span class="pl-k">=</span><span class="pl-s"><span class="pl-pds">'</span>source<span class="pl-pds">'</span></span>,
+ <span class="pl-s"><span class="pl-pds">'</span>format<span class="pl-pds">'</span></span><span class="pl-k">=</span><span class="pl-s"><span class="pl-pds">'</span>socket<span class="pl-pds">'</span></span>,
+ <span class="pl-s"><span class="pl-pds">'</span>host<span class="pl-pds">'</span></span><span class="pl-k">=</span><span class="pl-s"><span class="pl-pds">'</span>localhost<span class="pl-pds">'</span></span>,
+ <span class="pl-s"><span class="pl-pds">'</span>port<span class="pl-pds">'</span></span><span class="pl-k">=</span><span class="pl-s"><span class="pl-pds">'</span>8888<span class="pl-pds">'</span></span>,
+ <span class="pl-s"><span class="pl-pds">'</span>record_format<span class="pl-pds">'</span></span><span class="pl-k">=</span><span class="pl-s"><span class="pl-pds">'</span>csv<span class="pl-pds">'</span></span>, <span class="pl-k">//</span> can be csv <span class="pl-k">or</span> json, default is csv
+ <span class="pl-s"><span class="pl-pds">'</span>delimiter<span class="pl-pds">'</span></span><span class="pl-k">=</span><span class="pl-s"><span class="pl-pds">'</span>|<span class="pl-pds">'</span></span>
)</pre></div>
<p>will translate to</p>
<div class="highlight highlight-source-scala"><pre>spark.readStream
.schema(tableSchema)
.format(<span class="pl-s"><span class="pl-pds">"</span>socket<span class="pl-pds">"</span></span>)
.option(<span class="pl-s"><span class="pl-pds">"</span>host<span class="pl-pds">"</span></span>, <span class="pl-s"><span class="pl-pds">"</span>localhost<span class="pl-pds">"</span></span>)
- .option(<span class="pl-s"><span class="pl-pds">"</span>port<span class="pl-pds">"</span></span>, <span class="pl-s"><span class="pl-pds">"</span>8888<span class="pl-pds">"</span></span>)</pre></div>
+ .option(<span class="pl-s"><span class="pl-pds">"</span>port<span class="pl-pds">"</span></span>, <span class="pl-s"><span class="pl-pds">"</span>8888<span class="pl-pds">"</span></span>)
+ .option(<span class="pl-s"><span class="pl-pds">"</span>delimiter<span class="pl-pds">"</span></span>, <span class="pl-s"><span class="pl-pds">"</span>|<span class="pl-pds">"</span></span>)</pre></div>
</li>
<li>
<p>The sink table should have a TBLPROPERTY <code>'streaming'</code> equal to <code>true</code>, indicating it is a streaming table.</p>
@@ -621,9 +634,23 @@ TBLPROPERTIES(
<p>In the given STMPROPERTIES, user must specify <code>'trigger'</code>, its value must be <code>ProcessingTime</code> (In future, other value will be supported). User should also specify interval value for the streaming job.</p>
</li>
<li>
-<p>If the schema specifid in sink table is different from CTAS, the streaming job will fail</p>
+<p>If the schema specified in sink table is different from CTAS, the streaming job will fail</p>
</li>
</ul>
+<p>For Kafka data source, create the source table by:</p>
+<div class="highlight highlight-source-sql"><pre><span class="pl-k">CREATE</span> <span class="pl-k">TABLE</span> <span class="pl-en">source</span>(
+ name STRING,
+ age <span class="pl-k">INT</span>
+)
+STORED <span class="pl-k">AS</span> carbondata
+TBLPROPERTIES(
+ <span class="pl-s"><span class="pl-pds">'</span>streaming<span class="pl-pds">'</span></span><span class="pl-k">=</span><span class="pl-s"><span class="pl-pds">'</span>source<span class="pl-pds">'</span></span>,
+ <span class="pl-s"><span class="pl-pds">'</span>format<span class="pl-pds">'</span></span><span class="pl-k">=</span><span class="pl-s"><span class="pl-pds">'</span>kafka<span class="pl-pds">'</span></span>,
+ <span class="pl-s"><span class="pl-pds">'</span>kafka.bootstrap.servers<span class="pl-pds">'</span></span><span class="pl-k">=</span><span class="pl-s"><span class="pl-pds">'</span>kafkaserver:9092<span class="pl-pds">'</span></span>,
+ <span class="pl-s"><span class="pl-pds">'</span>subscribe<span class="pl-pds">'</span></span><span class="pl-k">=</span><span class="pl-s"><span class="pl-pds">'</span>test<span class="pl-pds">'</span></span>
+ <span class="pl-s"><span class="pl-pds">'</span>record_format<span class="pl-pds">'</span></span><span class="pl-k">=</span><span class="pl-s"><span class="pl-pds">'</span>csv<span class="pl-pds">'</span></span>, <span class="pl-k">//</span> can be csv <span class="pl-k">or</span> json, default is csv
+ <span class="pl-s"><span class="pl-pds">'</span>delimiter<span class="pl-pds">'</span></span><span class="pl-k">=</span><span class="pl-s"><span class="pl-pds">'</span>|<span class="pl-pds">'</span></span>
+)</pre></div>
<h5>
<a id="stop-stream" class="anchor" href="#stop-stream" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>STOP STREAM</h5>
<p>When this is issued, the streaming job will be stopped immediately. It will fail if the jobName specified is not exist.</p>
http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6ad7599a/src/main/webapp/supported-data-types-in-carbondata.html
----------------------------------------------------------------------
diff --git a/src/main/webapp/supported-data-types-in-carbondata.html b/src/main/webapp/supported-data-types-in-carbondata.html
index f346052..6c692b8 100644
--- a/src/main/webapp/supported-data-types-in-carbondata.html
+++ b/src/main/webapp/supported-data-types-in-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>
@@ -223,7 +231,10 @@
<li>BIGINT</li>
<li>DOUBLE</li>
<li>DECIMAL</li>
+<li>FLOAT</li>
+<li>BYTE</li>
</ul>
+<p><strong>NOTE</strong>: Float and Bytes are only supported for SDK and FileFormat.</p>
</li>
<li>
<p>Date/Time Types</p>
@@ -249,6 +260,8 @@ Please refer to TBLProperties in <a href="./ddl-of-carbondata.html#create-table"
</li>
<li>structs: STRUCT<code><col_name : data_type COMMENT col_comment, ...></code>
</li>
+<li>maps: MAP<code><primitive_type, data_type></code>
+</li>
</ul>
<p><strong>NOTE</strong>: Only 2 level complex type schema is supported for now.</p>
</li>
http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6ad7599a/src/main/webapp/timeseries-datamap-guide.html
----------------------------------------------------------------------
diff --git a/src/main/webapp/timeseries-datamap-guide.html b/src/main/webapp/timeseries-datamap-guide.html
index 73a4580..d34a013 100644
--- a/src/main/webapp/timeseries-datamap-guide.html
+++ b/src/main/webapp/timeseries-datamap-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>
http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6ad7599a/src/main/webapp/usecases.html
----------------------------------------------------------------------
diff --git a/src/main/webapp/usecases.html b/src/main/webapp/usecases.html
index cb309dd..3ff114a 100644
--- a/src/main/webapp/usecases.html
+++ b/src/main/webapp/usecases.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>
@@ -258,7 +266,7 @@
<a id="detailed-queries-in-the-telecom-scenario" class="anchor" href="#detailed-queries-in-the-telecom-scenario" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Detailed Queries in the Telecom scenario</h2>
<h3>
<a id="scenario" class="anchor" href="#scenario" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Scenario</h3>
-<p>User wants to analyse all the CHR(Call History Record) and MR(Measurement Records) of the mobile subscribers in order to identify the service failures within 10 secs.Also user wants to run machine learning models on the data to fairly estimate the reasons and time of probable failures and take action ahead to meet the SLA(Service Level Agreements) of VIP customers.</p>
+<p>User wants to analyse all the CHR(Call History Record) and MR(Measurement Records) of the mobile subscribers in order to identify the service failures within 10 secs. Also user wants to run machine learning models on the data to fairly estimate the reasons and time of probable failures and take action ahead to meet the SLA(Service Level Agreements) of VIP customers.</p>
<h3>
<a id="challenges" class="anchor" href="#challenges" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Challenges</h3>
<ul>
@@ -271,7 +279,7 @@
<a id="solution" class="anchor" href="#solution" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Solution</h3>
<p>Setup a Hadoop + Spark + CarbonData cluster managed by YARN.</p>
<p>Proposed the following configurations for CarbonData.(These tunings were proposed before CarbonData introduced SORT_COLUMNS parameter using which the sort order and schema order could be different.)</p>
-<p>Add the frequently used columns to the left of the table definition.Add it in the increasing order of cardinality.It was suggested to keep msisdn,imsi columns in the beginning of the schema.With latest CarbonData, SORT_COLUMNS needs to be configured msisdn,imsi in the beginning.</p>
+<p>Add the frequently used columns to the left of the table definition. Add it in the increasing order of cardinality. It was suggested to keep msisdn,imsi columns in the beginning of the schema. With latest CarbonData, SORT_COLUMNS needs to be configured msisdn,imsi in the beginning.</p>
<p>Add timestamp column to the right of the schema as it is naturally increasing.</p>
<p>Create two separate YARN queues for Query and Data Loading.</p>
<p>Apart from these, the following CarbonData configuration was suggested to be configured in the cluster.</p>
@@ -319,7 +327,7 @@
<td>Data Loading</td>
<td>carbon.use.local.dir</td>
<td>TRUE</td>
-<td>yarn application directory will be usually on a single disk.YARN would be configured with multiple disks to be used as temp or to assign randomly to applications.Using the yarn temp directory will allow carbon to use multiple disks and improve IO performance</td>
+<td>yarn application directory will be usually on a single disk.YARN would be configured with multiple disks to be used as temp or to assign randomly to applications. Using the yarn temp directory will allow carbon to use multiple disks and improve IO performance</td>
</tr>
<tr>
<td>Data Loading</td>
@@ -381,7 +389,7 @@
<a id="detailed-queries-in-the-smart-city-scenario" class="anchor" href="#detailed-queries-in-the-smart-city-scenario" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Detailed Queries in the Smart City scenario</h2>
<h3>
<a id="scenario-1" class="anchor" href="#scenario-1" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Scenario</h3>
-<p>User wants to analyse the person/vehicle movement and behavior during a certain time period.This output data needs to be joined with a external table for Human details extraction.The query will be run with different time period as filter to identify potential behavior mismatch.</p>
+<p>User wants to analyse the person/vehicle movement and behavior during a certain time period. This output data needs to be joined with a external table for Human details extraction. The query will be run with different time period as filter to identify potential behavior mismatch.</p>
<h3>
<a id="challenges-1" class="anchor" href="#challenges-1" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Challenges</h3>
<p>Data generated per day is very huge.Data needs to be loaded multiple times per day to accomodate the incoming data size.</p>
@@ -414,13 +422,13 @@
<td>Data Loading</td>
<td>enable.unsafe.sort</td>
<td>TRUE</td>
-<td>Temporary data generated during sort is huge which causes GC bottlenecks.Using unsafe reduces the pressure on GC</td>
+<td>Temporary data generated during sort is huge which causes GC bottlenecks. Using unsafe reduces the pressure on GC</td>
</tr>
<tr>
<td>Data Loading</td>
<td>enable.offheap.sort</td>
<td>TRUE</td>
-<td>Temporary data generated during sort is huge which causes GC bottlenecks.Using offheap reduces the pressure on GC.offheap can be accessed through java unsafe.hence enable.unsafe.sort needs to be true</td>
+<td>Temporary data generated during sort is huge which causes GC bottlenecks. Using offheap reduces the pressure on GC.offheap can be accessed through java unsafe.hence enable.unsafe.sort needs to be true</td>
</tr>
<tr>
<td>Data Loading</td>
@@ -444,7 +452,7 @@
<td>Data Loading</td>
<td>table_blocksize</td>
<td>512</td>
-<td>To efficiently schedule multiple tasks during query.This size depends on data scenario.If data is such that the filters would select less number of blocklets to scan, keeping higher number works well.If the number blocklets to scan is more, better to reduce the size as more tasks can be scheduled in parallel.</td>
+<td>To efficiently schedule multiple tasks during query. This size depends on data scenario.If data is such that the filters would select less number of blocklets to scan, keeping higher number works well.If the number blocklets to scan is more, better to reduce the size as more tasks can be scheduled in parallel.</td>
</tr>
<tr>
<td>Data Loading</td>
@@ -456,7 +464,7 @@
<td>Data Loading</td>
<td>carbon.use.local.dir</td>
<td>TRUE</td>
-<td>yarn application directory will be usually on a single disk.YARN would be configured with multiple disks to be used as temp or to assign randomly to applications.Using the yarn temp directory will allow carbon to use multiple disks and improve IO performance</td>
+<td>yarn application directory will be usually on a single disk.YARN would be configured with multiple disks to be used as temp or to assign randomly to applications. Using the yarn temp directory will allow carbon to use multiple disks and improve IO performance</td>
</tr>
<tr>
<td>Data Loading</td>
@@ -468,7 +476,7 @@
<td>Data Loading</td>
<td>sort.inmemory.size.in.mb</td>
<td>92160</td>
-<td>Memory allocated to do inmemory sorting.When more memory is available in the node, configuring this will retain more sort blocks in memory so that the merge sort is faster due to no/very less IO</td>
+<td>Memory allocated to do inmemory sorting. When more memory is available in the node, configuring this will retain more sort blocks in memory so that the merge sort is faster due to no/very less IO</td>
</tr>
<tr>
<td>Compaction</td>
@@ -486,7 +494,7 @@
<td>Compaction</td>
<td>carbon.enable.auto.load.merge</td>
<td>FALSE</td>
-<td>Doing auto minor compaction is costly process as data size is huge.Perform manual compaction when the cluster is less loaded</td>
+<td>Doing auto minor compaction is costly process as data size is huge.Perform manual compaction when the cluster is less loaded</td>
</tr>
<tr>
<td>Query</td>
@@ -498,13 +506,13 @@
<td>Query</td>
<td>enable.unsafe.in.query.procressing</td>
<td>true</td>
-<td>Data that needs to be scanned in huge which in turn generates more short lived Java objects.This cause pressure of GC.using unsafe and offheap will reduce the GC overhead</td>
+<td>Data that needs to be scanned in huge which in turn generates more short lived Java objects. This cause pressure of GC.using unsafe and offheap will reduce the GC overhead</td>
</tr>
<tr>
<td>Query</td>
<td>use.offheap.in.query.processing</td>
<td>true</td>
-<td>Data that needs to be scanned in huge which in turn generates more short lived Java objects.This cause pressure of GC.using unsafe and offheap will reduce the GC overhead.offheap can be accessed through java unsafe.hence enable.unsafe.in.query.procressing needs to be true</td>
+<td>Data that needs to be scanned in huge which in turn generates more short lived Java objects. This cause pressure of GC.using unsafe and offheap will reduce the GC overhead.offheap can be accessed through java unsafe.hence enable.unsafe.in.query.procressing needs to be true</td>
</tr>
<tr>
<td>Query</td>
@@ -516,7 +524,7 @@
<td>Query</td>
<td>carbon.unsafe.working.memory.in.mb</td>
<td>10240</td>
-<td>Amount of memory to use for offheap operations.Can increase this memory based on the data size</td>
+<td>Amount of memory to use for offheap operations, you can increase this memory based on the data size</td>
</tr>
</tbody>
</table>
@@ -565,7 +573,7 @@
<li>Create pre-aggregate tables for non timestamp based group by queries</li>
<li>For queries containing group by date, create timeseries based Datamap(pre-aggregate) tables so that the data is rolled up during creation and fetch is faster</li>
<li>Reduce the Spark shuffle partitions.(In our configuration on 14 node cluster, it was reduced to 35 from default of 200)</li>
-<li>Enable global dictionary for columns which have less cardinalities.Aggregation can be done on encoded data, there by improving the performance</li>
+<li>Enable global dictionary for columns which have less cardinalities. Aggregation can be done on encoded data, there by improving the performance</li>
<li>For columns whose cardinality is high,enable the local dictionary so that store size is less and can take dictionary benefit for scan</li>
</ul>
<h2>
@@ -575,13 +583,13 @@
<p>Need to support storing of continously arriving data and make it available immediately for query.</p>
<h3>
<a id="challenges-3" class="anchor" href="#challenges-3" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Challenges</h3>
-<p>When the data ingestion is near real time and the data needs to be available for query immediately, usual scenario is to do data loading in micro batches.But this causes the problem of generating many small files.This poses two problems:</p>
+<p>When the data ingestion is near real time and the data needs to be available for query immediately, usual scenario is to do data loading in micro batches.But this causes the problem of generating many small files. This poses two problems:</p>
<ol>
<li>Small file handling in HDFS is inefficient</li>
<li>CarbonData will suffer in query performance as all the small files will have to be queried when filter is on non time column</li>
</ol>
<p>CarbonData will suffer in query performance as all the small files will have to be queried when filter is on non time column.</p>
-<p>Since data is continouly arriving, allocating resources for compaction might not be feasible.</p>
+<p>Since data is continously arriving, allocating resources for compaction might not be feasible.</p>
<h3>
<a id="goal-1" class="anchor" href="#goal-1" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Goal</h3>
<ol>
http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6ad7599a/src/site/markdown/CSDK-guide.md
----------------------------------------------------------------------
diff --git a/src/site/markdown/CSDK-guide.md b/src/site/markdown/CSDK-guide.md
new file mode 100644
index 0000000..c4f4a31
--- /dev/null
+++ b/src/site/markdown/CSDK-guide.md
@@ -0,0 +1,197 @@
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to you under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+# CSDK Guide
+
+CarbonData CSDK provides C++ interface to write and read carbon file.
+CSDK use JNI to invoke java SDK in C++ code.
+
+
+# CSDK Reader
+This CSDK reader reads CarbonData file and carbonindex file at a given path.
+External client can make use of this reader to read CarbonData files in C++
+code and without CarbonSession.
+
+
+In the carbon jars package, there exist a carbondata-sdk.jar,
+including SDK reader for CSDK.
+## Quick example
+```
+// 1. init JVM
+JavaVM *jvm;
+JNIEnv *initJVM() {
+ JNIEnv *env;
+ JavaVMInitArgs vm_args;
+ int parNum = 3;
+ int res;
+ JavaVMOption options[parNum];
+
+ options[0].optionString = "-Djava.compiler=NONE";
+ options[1].optionString = "-Djava.class.path=../../sdk/target/carbondata-sdk.jar";
+ options[2].optionString = "-verbose:jni";
+ vm_args.version = JNI_VERSION_1_8;
+ vm_args.nOptions = parNum;
+ vm_args.options = options;
+ vm_args.ignoreUnrecognized = JNI_FALSE;
+
+ res = JNI_CreateJavaVM(&jvm, (void **) &env, &vm_args);
+ if (res < 0) {
+ fprintf(stderr, "\nCan't create Java VM\n");
+ exit(1);
+ }
+
+ return env;
+}
+
+// 2. create carbon reader and read data
+// 2.1 read data from local disk
+/**
+ * test read data from local disk, without projection
+ *
+ * @param env jni env
+ * @return
+ */
+bool readFromLocalWithoutProjection(JNIEnv *env) {
+
+ CarbonReader carbonReaderClass;
+ carbonReaderClass.builder(env, "../resources/carbondata", "test");
+ carbonReaderClass.build();
+
+ while (carbonReaderClass.hasNext()) {
+ jobjectArray row = carbonReaderClass.readNextRow();
+ jsize length = env->GetArrayLength(row);
+ int j = 0;
+ for (j = 0; j < length; j++) {
+ jobject element = env->GetObjectArrayElement(row, j);
+ char *str = (char *) env->GetStringUTFChars((jstring) element, JNI_FALSE);
+ printf("%s\t", str);
+ }
+ printf("\n");
+ }
+ carbonReaderClass.close();
+}
+
+// 2.2 read data from S3
+
+/**
+ * read data from S3
+ * parameter is ak sk endpoint
+ *
+ * @param env jni env
+ * @param argv argument vector
+ * @return
+ */
+bool readFromS3(JNIEnv *env, char *argv[]) {
+ CarbonReader reader;
+
+ char *args[3];
+ // "your access key"
+ args[0] = argv[1];
+ // "your secret key"
+ args[1] = argv[2];
+ // "your endPoint"
+ args[2] = argv[3];
+
+ reader.builder(env, "s3a://sdk/WriterOutput", "test");
+ reader.withHadoopConf(3, args);
+ reader.build();
+ printf("\nRead data from S3:\n");
+ while (reader.hasNext()) {
+ jobjectArray row = reader.readNextRow();
+ jsize length = env->GetArrayLength(row);
+
+ int j = 0;
+ for (j = 0; j < length; j++) {
+ jobject element = env->GetObjectArrayElement(row, j);
+ char *str = (char *) env->GetStringUTFChars((jstring) element, JNI_FALSE);
+ printf("%s\t", str);
+ }
+ printf("\n");
+ }
+
+ reader.close();
+}
+
+// 3. destory JVM
+ (jvm)->DestroyJavaVM();
+```
+Find example code at main.cpp of CSDK module
+
+## API List
+```
+ /**
+ * create a CarbonReaderBuilder object for building carbonReader,
+ * CarbonReaderBuilder object can configure different parameter
+ *
+ * @param env JNIEnv
+ * @param path data store path
+ * @param tableName table name
+ * @return CarbonReaderBuilder object
+ */
+ jobject builder(JNIEnv *env, char *path, char *tableName);
+
+ /**
+ * Configure the projection column names of carbon reader
+ *
+ * @param argc argument counter
+ * @param argv argument vector
+ * @return CarbonReaderBuilder object
+ */
+ jobject projection(int argc, char *argv[]);
+
+ /**
+ * build carbon reader with argument vector
+ * it support multiple parameter
+ * like: key=value
+ * for example: fs.s3a.access.key=XXXX, XXXX is user's access key value
+ *
+ * @param argc argument counter
+ * @param argv argument vector
+ * @return CarbonReaderBuilder object
+ **/
+ jobject withHadoopConf(int argc, char *argv[]);
+
+ /**
+ * build carbonReader object for reading data
+ * it support read data from load disk
+ *
+ * @return carbonReader object
+ */
+ jobject build();
+
+ /**
+ * Whether it has next row data
+ *
+ * @return boolean value, if it has next row, return true. if it hasn't next row, return false.
+ */
+ jboolean hasNext();
+
+ /**
+ * read next row from data
+ *
+ * @return object array of one row
+ */
+ jobjectArray readNextRow();
+
+ /**
+ * close the carbon reader
+ *
+ * @return boolean value
+ */
+ jboolean close();
+
+```
http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6ad7599a/src/site/markdown/bloomfilter-datamap-guide.md
----------------------------------------------------------------------
diff --git a/src/site/markdown/bloomfilter-datamap-guide.md b/src/site/markdown/bloomfilter-datamap-guide.md
index b2e7d60..fb244fe 100644
--- a/src/site/markdown/bloomfilter-datamap-guide.md
+++ b/src/site/markdown/bloomfilter-datamap-guide.md
@@ -15,7 +15,7 @@
limitations under the License.
-->
-# CarbonData BloomFilter DataMap (Alpha Feature)
+# CarbonData BloomFilter DataMap
* [DataMap Management](#datamap-management)
* [BloomFilter Datamap Introduction](#bloomfilter-datamap-introduction)
@@ -46,7 +46,7 @@ Showing all DataMaps on this table
```
Disable Datamap
-> The datamap by default is enabled. To support tuning on query, we can disable a specific datamap during query to observe whether we can gain performance enhancement from it. This will only take effect current session.
+> The datamap by default is enabled. To support tuning on query, we can disable a specific datamap during query to observe whether we can gain performance enhancement from it. This is effective only for current session.
```
// disable the datamap
@@ -82,7 +82,7 @@ and we always query on `id` and `name` with precise value.
since `id` is in the sort_columns and it is orderd,
query on it will be fast because CarbonData can skip all the irrelative blocklets.
But queries on `name` may be bad since the blocklet minmax may not help,
-because in each blocklet the range of the value of `name` may be the same -- all from A*~z*.
+because in each blocklet the range of the value of `name` may be the same -- all from A* to z*.
In this case, user can create a BloomFilter datamap on column `name`.
Moreover, user can also create a BloomFilter datamap on the sort_columns.
This is useful if user has too many segments and the range of the value of sort_columns are almost the same.
http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6ad7599a/src/site/markdown/carbon-as-spark-datasource-guide.md
----------------------------------------------------------------------
diff --git a/src/site/markdown/carbon-as-spark-datasource-guide.md b/src/site/markdown/carbon-as-spark-datasource-guide.md
new file mode 100644
index 0000000..bc56a54
--- /dev/null
+++ b/src/site/markdown/carbon-as-spark-datasource-guide.md
@@ -0,0 +1,99 @@
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to you under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+# CarbonData as Spark's Datasource
+
+The CarbonData fileformat is now integrated as Spark datasource for read and write operation without using CarbonSession. This is useful for users who wants to use carbondata as spark's data source.
+
+**Note:** You can only apply the functions/features supported by spark datasource APIs, functionalities supported would be similar to Parquet. The carbon session features are not supported.
+
+# Create Table with DDL
+
+Now you can create Carbon table using Spark's datasource DDL syntax.
+
+```
+ CREATE [TEMPORARY] TABLE [IF NOT EXISTS] [db_name.]table_name
+ [(col_name1 col_type1 [COMMENT col_comment1], ...)]
+ USING CARBON
+ [OPTIONS (key1=val1, key2=val2, ...)]
+ [PARTITIONED BY (col_name1, col_name2, ...)]
+ [CLUSTERED BY (col_name3, col_name4, ...) INTO num_buckets BUCKETS]
+ [LOCATION path]
+ [COMMENT table_comment]
+ [TBLPROPERTIES (key1=val1, key2=val2, ...)]
+ [AS select_statement]
+```
+
+## Supported OPTIONS
+
+| Property | Default Value | Description |
+|-----------|--------------|------------|
+| table_blocksize | 1024 | Size of blocks to write onto hdfs. For more details, see [Table Block Size Configuration](./ddl-of-carbondata.md#table-block-size-configuration). |
+| table_blocklet_size | 64 | Size of blocklet to write. |
+| local_dictionary_threshold | 10000 | Cardinality upto which the local dictionary can be generated. For more details, see [Local Dictionary Configuration](./ddl-of-carbondata.md#local-dictionary-configuration). |
+| local_dictionary_enable | false | Enable local dictionary generation. For more details, see [Local Dictionary Configuration](./ddl-of-carbondata.md#local-dictionary-configuration). |
+| sort_columns | all dimensions are sorted | Columns to include in sort and its order of sort. For more details, see [Sort Columns Configuration](./ddl-of-carbondata.md#sort-columns-configuration). |
+| sort_scope | local_sort | Sort scope of the load.Options include no sort, local sort, batch sort, and global sort. For more details, see [Sort Scope Configuration](./ddl-of-carbondata.md#sort-scope-configuration). |
+| long_string_columns | null | Comma separated string/char/varchar columns which are more than 32k length. For more details, see [String longer than 32000 characters](./ddl-of-carbondata.md#string-longer-than-32000-characters). |
+
+## Example
+
+```
+ CREATE TABLE CARBON_TABLE (NAME STRING) USING CARBON OPTIONS('table_block_size'='256')
+```
+
+# Using DataFrame
+
+Carbon format can be used in dataframe also. Following are the ways to use carbon format in dataframe.
+
+Write carbon using dataframe
+```
+df.write.format("carbon").save(path)
+```
+
+Read carbon using dataframe
+```
+val df = spark.read.format("carbon").load(path)
+```
+
+## Example
+
+```
+import org.apache.spark.sql.SparkSession
+
+val spark = SparkSession
+ .builder()
+ .appName("Spark SQL basic example")
+ .config("spark.some.config.option", "some-value")
+ .getOrCreate()
+
+// For implicit conversions like converting RDDs to DataFrames
+import spark.implicits._
+val df = spark.sparkContext.parallelize(1 to 10 * 10 * 1000)
+ .map(x => (r.nextInt(100000), "name" + x % 8, "city" + x % 50, BigDecimal.apply(x % 60)))
+ .toDF("ID", "name", "city", "age")
+
+// Write to carbon format
+df.write.format("carbon").save("/user/person_table")
+
+// Read carbon using dataframe
+val dfread = spark.read.format("carbon").load("/user/person_table")
+dfread.show()
+```
+
+Reference : [list of carbon properties](./configuration-parameters.md)
+
[13/20] carbondata-site git commit: modified for 1.5.0 version
Posted by ch...@apache.org.
http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6ad7599a/content/css/style.css
----------------------------------------------------------------------
diff --git a/content/css/style.css b/content/css/style.css
index 88fd05f..ef82297 100644
--- a/content/css/style.css
+++ b/content/css/style.css
@@ -1307,6 +1307,11 @@ width:80%;
padding-left:30px;
}
+@media screen and (min-width: 1690px) {
+ .verticalnavbar{
+ width: 11% !important;}
+}
+
.verticalnavbar {
float: left;
text-transform: uppercase;
http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6ad7599a/content/data-management-on-carbondata.html
----------------------------------------------------------------------
diff --git a/content/data-management-on-carbondata.html b/content/data-management-on-carbondata.html
deleted file mode 100644
index 566bb8e..0000000
--- a/content/data-management-on-carbondata.html
+++ /dev/null
@@ -1,1321 +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.4.1/"
- target="_blank">Apache CarbonData 1.4.1</a></li>
- <li>
- <a href="https://dist.apache.org/repos/dist/release/carbondata/1.4.0/"
- target="_blank">Apache CarbonData 1.4.0</a></li>
- <li>
- <a href="https://dist.apache.org/repos/dist/release/carbondata/1.3.1/"
- target="_blank">Apache CarbonData 1.3.1</a></li>
- <li>
- <a href="https://dist.apache.org/repos/dist/release/carbondata/1.3.0/"
- target="_blank">Apache CarbonData 1.3.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-on-carbondata" class="anchor" href="#data-management-on-carbondata" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Data Management on CarbonData</h1>
-<p>This tutorial is going to introduce all commands and data operations on CarbonData.</p>
-<ul>
-<li><a href="#create-table">CREATE TABLE</a></li>
-<li><a href="#create-database">CREATE DATABASE</a></li>
-<li><a href="#table-management">TABLE MANAGEMENT</a></li>
-<li><a href="#load-data">LOAD DATA</a></li>
-<li><a href="#update-and-delete">UPDATE AND DELETE</a></li>
-<li><a href="#compaction">COMPACTION</a></li>
-<li><a href="#partition">PARTITION</a></li>
-<li><a href="#bucketing">BUCKETING</a></li>
-<li><a href="#segment-management">SEGMENT MANAGEMENT</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. You can also specify the location where the table needs to be stored.</p>
-<pre><code>CREATE TABLE [IF NOT EXISTS] [db_name.]table_name[(col_name data_type , ...)]
-STORED AS carbondata
-[TBLPROPERTIES (property_name=property_value, ...)]
-[LOCATION 'path']
-</code></pre>
-<p><strong>NOTE:</strong> CarbonData also supports "STORED AS carbondata" and "USING carbondata". Find example code at <a href="https://github.com/apache/carbondata/blob/master/examples/spark2/src/main/scala/org/apache/carbondata/examples/CarbonSessionExample.scala" target=_blank>CarbonSessionExample</a> in the CarbonData repo.</p>
-<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 TBLPROPERTIES, CarbonData's additional table options can be set via carbon.properties.</p>
-<ul>
-<li>
-<p><strong>Dictionary Encoding Configuration</strong></p>
-<p>Dictionary encoding is turned off for all columns by default from 1.3 onwards, you can use this command for including or excluding columns to do dictionary encoding.
-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>NOTE: Dictionary Include/Exclude for complex child columns is not supported.</p>
-</li>
-<li>
-<p><strong>Inverted Index Configuration</strong></p>
-<p>By default inverted index is enabled, it might help to improve compression ratio and query speed, especially for low cardinality columns which are in reward position.
-Suggested use cases : For high cardinality columns, you can disable the inverted index for improving the data loading performance.</p>
-<pre><code>TBLPROPERTIES ('NO_INVERTED_INDEX'='column1, column3')
-</code></pre>
-</li>
-<li>
-<p><strong>Sort Columns Configuration</strong></p>
-<p>This property is for users to specify which columns belong to the MDK(Multi-Dimensions-Key) index.</p>
-<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.
-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>
-</li>
-<li>
-<p><strong>Sort Scope Configuration</strong></p>
-<p>This property is for users to specify the scope of the sort during data load, following are the types of sort scope.</p>
-<ul>
-<li>LOCAL_SORT: It is the default sort scope.</li>
-<li>NO_SORT: It will load the data in unsorted manner, it will significantly increase load performance.</li>
-<li>BATCH_SORT: It increases the load performance but decreases the query performance if identified blocks > parallelism.</li>
-<li>GLOBAL_SORT: It increases the query performance, especially high concurrent point query.
-And if you care about loading resources isolation strictly, because the system uses the spark GroupBy to sort data, the resource can be controlled by spark.</li>
-</ul>
-</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 BY '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>
-<p><strong>Table Block Size Configuration</strong></p>
-<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>
-<pre><code>TBLPROPERTIES ('TABLE_BLOCKSIZE'='512')
-</code></pre>
-<p><strong>NOTE:</strong> 512 or 512M both are accepted.</p>
-</li>
-<li>
-<p><strong>Table Compaction Configuration</strong></p>
-<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>
-<ul>
-<li>MAJOR_COMPACTION_SIZE: same meaning as carbon.major.compaction.size, size in MB.</li>
-<li>AUTO_LOAD_MERGE: same meaning as carbon.enable.auto.load.merge.</li>
-<li>COMPACTION_LEVEL_THRESHOLD: same meaning as carbon.compaction.level.threshold.</li>
-<li>COMPACTION_PRESERVE_SEGMENTS: same meaning as carbon.numberof.preserve.segments.</li>
-<li>ALLOWED_COMPACTION_DAYS: same meaning as carbon.allowed.compaction.days.</li>
-</ul>
-<pre><code>TBLPROPERTIES ('MAJOR_COMPACTION_SIZE'='2048',
- 'AUTO_LOAD_MERGE'='true',
- 'COMPACTION_LEVEL_THRESHOLD'='5,6',
- 'COMPACTION_PRESERVE_SEGMENTS'='10',
- 'ALLOWED_COMPACTION_DAYS'='5')
-</code></pre>
-</li>
-<li>
-<p><strong>Streaming</strong></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>
-<li>
-<p><strong>Local Dictionary Configuration</strong></p>
-</li>
-</ul>
-<p>Columns for which dictionary is not generated needs more storage space and in turn more IO. Also since more data will have to be read during query, query performance also would suffer.Generating dictionary per blocklet for such columns would help in saving storage space and assist in improving query performance as carbondata is optimized for handling dictionary encoded columns more effectively.Generating dictionary internally per blocklet is termed as local dictionary. Please refer to <a href="../file-structure-of-carbondata.html">File structure of Carbondata</a> for understanding about the file structure of carbondata and meaning of terms like blocklet.</p>
-<p>Local Dictionary helps in:</p>
-<ol>
-<li>Getting more compression.</li>
-<li>Filter queries and full scan queries will be faster as filter will be done on encoded data.</li>
-<li>Reducing the store size and memory footprint as only unique values will be stored as part of local dictionary and corresponding data will be stored as encoded data.</li>
-<li>Getting higher IO throughput.</li>
-</ol>
-<p><strong>NOTE:</strong></p>
-<ul>
-<li>
-<p>Following Data Types are Supported for Local Dictionary:</p>
-<ul>
-<li>STRING</li>
-<li>VARCHAR</li>
-<li>CHAR</li>
-</ul>
-</li>
-<li>
-<p>Following Data Types are not Supported for Local Dictionary:</p>
-<ul>
-<li>SMALLINT</li>
-<li>INTEGER</li>
-<li>BIGINT</li>
-<li>DOUBLE</li>
-<li>DECIMAL</li>
-<li>TIMESTAMP</li>
-<li>DATE</li>
-<li>BOOLEAN</li>
-</ul>
-</li>
-<li>
-<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 system property 'carbon.local.dictionary.enable'. By default, Local Dictionary will be disabled for the carbondata table.</p>
-<p>Local Dictionary can be configured using the following properties during create table command:</p>
-<table>
-<thead>
-<tr>
-<th>Properties</th>
-<th>Default value</th>
-<th>Description</th>
-</tr>
-</thead>
-<tbody>
-<tr>
-<td>LOCAL_DICTIONARY_ENABLE</td>
-<td>false</td>
-<td>Whether to enable local dictionary generation. <strong>NOTE:</strong> If this property is defined, it will override the value configured at system level by 'carbon.local.dictionary.enable'</td>
-</tr>
-<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>
-</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.</td>
-</tr>
-<tr>
-<td>LOCAL_DICTIONARY_EXCLUDE</td>
-<td>none</td>
-<td>Columns for which Local Dictionary need not be generated.</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>
-</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>
-<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>
-<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(
-
- column1 string,
-
- column2 string,
-
- column3 LONG )
-
- STORED BY 'carbondata'
- TBLPROPERTIES('LOCAL_DICTIONARY_ENABLE'='true','LOCAL_DICTIONARY_THRESHOLD'='1000',
- 'LOCAL_DICTIONARY_INCLUDE'='column1','LOCAL_DICTIONARY_EXCLUDE'='column2')
-</code></pre>
-<p><strong>NOTE:</strong></p>
-<ul>
-<li>We recommend to use Local Dictionary when cardinality is high but is distributed across multiple loads</li>
-<li>On a large cluster, decoding data can become a bottleneck for global dictionary as there will be many remote reads. In this scenario, it is better to use Local Dictionary.</li>
-<li>When cardinality is less, but loads are repetitive, it is better to use global dictionary as local dictionary generates multiple dictionary files at blocklet level increasing redundancy.</li>
-</ul>
-<ul>
-<li>
-<p><strong>Caching Min/Max Value for Required Columns</strong>
-By default, CarbonData caches min and max values of all the columns in schema. As the load increases, the memory required to hold the min and max values increases considerably. This feature enables you to configure min and max values only for the required columns, resulting in optimized memory usage.</p>
-<p>Following are the valid values for COLUMN_META_CACHE:</p>
-<ul>
-<li>If you want no column min/max values to be cached in the driver.</li>
-</ul>
-<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?
-</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,??
-</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,??)
-</code></pre>
-<p>Example:</p>
-<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,??)
-</code></pre>
-<p>Example:</p>
-<pre><code>ALTER TABLE employee SET TBLPROPERTIES (?COLUMN_META_CACHE?=?city?)
-</code></pre>
-</li>
-<li>
-<p><strong>Caching at Block or Blocklet Level</strong></p>
-<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?
-</code></pre>
-<p><em>Configuration for caching in driver at Blocklet level.</em></p>
-<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?)
-</code></pre>
-<p>Example:</p>
-<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?)
-</code></pre>
-<p>Example:</p>
-<pre><code>ALTER TABLE employee SET TBLPROPERTIES (?CACHE_LEVEL?=?Blocklet?)
-</code></pre>
-</li>
-</ul>
-<pre><code>- **Support Flat folder same as Hive/Parquet**
-
- 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.
-
- Following table property enables this feature and default value is false.
- ```
- 'flat_folder'='true'
- ```
- Example:
- ```
- CREATE TABLE employee (name String, city String, id int) STORED BY ?carbondata? TBLPROPERTIES ('flat_folder'='true')
- ```
-
-- **String longer than 32000 characters**
-
- In common scenarios, the length of string is less than 32000,
- so carbondata stores the length of content using Short to reduce memory and space consumption.
- To support string longer than 32000 characters, carbondata introduces a table property called `LONG_STRING_COLUMNS`.
- For these columns, carbondata internally stores the length of content using Integer.
-
- You can specify the columns as 'long string column' using below tblProperties:
-
- ```
- // specify col1, col2 as long string columns
- TBLPROPERTIES ('LONG_STRING_COLUMNS'='col1,col2')
- ```
-
- Besides, you can also use this property through DataFrame by
- ```
- df.format("carbondata")
- .option("tableName", "carbonTable")
- .option("long_string_columns", "col1, col2")
- .save()
- ```
-
- If you are using Carbon-SDK, you can specify the datatype of long string column as `varchar`.
- You can refer to SDKwriterTestCase for example.
-
- **NOTE:** The LONG_STRING_COLUMNS can only be string/char/varchar columns and cannot be dictionary_include/sort_columns/complex columns.
-</code></pre>
-<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>
-<p>This function allows user to create a Carbon table from any of the Parquet/Hive/Carbon table. This is beneficial when the user wants to create Carbon table from any other Parquet/Hive table and use the Carbon query engine to query and achieve better query results for cases where Carbon is faster than other file formats. Also this feature can be used for backing up the data.</p>
-<pre><code>CREATE TABLE [IF NOT EXISTS] [db_name.]table_name
-STORED BY 'carbondata'
-[TBLPROPERTIES (key1=val1, key2=val2, ...)]
-AS select_statement;
-</code></pre>
-<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>carbon.sql("CREATE TABLE source_table(
- id INT,
- name STRING,
- city STRING,
- age INT)
- STORED AS parquet")
-carbon.sql("INSERT INTO source_table SELECT 1,'bob','shenzhen',27")
-carbon.sql("INSERT INTO source_table SELECT 2,'david','shenzhen',31")
-
-carbon.sql("CREATE TABLE target_table
- STORED BY 'carbondata'
- AS SELECT city,avg(age) FROM source_table GROUP BY city")
-
-carbon.sql("SELECT * FROM target_table").show
- // results:
- // +--------+--------+
- // | city|avg(age)|
- // +--------+--------+
- // |shenzhen| 29.0|
- // +--------+--------+
-
-</code></pre>
-<h2>
-<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 BY '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>
-<p>Managed table data location provided will have both FACT and Metadata folder.
-This data can be generated by creating a normal carbon table and use this path as $FilesPath in the above syntax.</p>
-<p><strong>Example:</strong></p>
-<pre><code>sql("CREATE TABLE origin(key INT, value STRING) STORED BY 'carbondata'")
-sql("INSERT INTO origin select 100,'spark'")
-sql("INSERT INTO origin select 200,'hive'")
-// creates a table in $storeLocation/origin
-
-sql(s"""
-|CREATE EXTERNAL TABLE source
-|STORED BY 'carbondata'
-|LOCATION '$storeLocation/origin'
-""".stripMargin)
-checkAnswer(sql("SELECT count(*) from source"), sql("SELECT count(*) from origin"))
-</code></pre>
-<h3>
-<a id="create-external-table-on-non-transactional-table-data-location" class="anchor" href="#create-external-table-on-non-transactional-table-data-location" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Create external table on Non-Transactional table data location.</h3>
-<p>Non-Transactional table data location will have only carbondata and carbonindex files, there will not be a metadata folder (table status and schema).
-Our SDK module currently support writing data in this format.</p>
-<p><strong>Example:</strong></p>
-<pre><code>sql(
-s"""CREATE EXTERNAL TABLE sdkOutputTable STORED BY 'carbondata' LOCATION
-|'$writerPath' """.stripMargin)
-</code></pre>
-<p>Here writer path will have carbondata and index files.
-This can be SDK output. Refer <a href="https://github.com/apache/carbondata/blob/master/docs/sdk-writer-guide.html" target=_blank>SDK Writer Guide</a>.</p>
-<p><strong>Note:</strong></p>
-<ol>
-<li>Dropping of the external table should not delete the files present in the location.</li>
-<li>When external table is created on non-transactional table data,
-external table will be registered with the schema of carbondata files.
-If multiple files with different schema is present, exception will be thrown.
-So, If table registered with one schema and files are of different schema,
-suggest to drop the external table and create again to register table with new schema.</li>
-</ol>
-<h2>
-<a id="create-database" class="anchor" href="#create-database" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>CREATE DATABASE</h2>
-<p>This function creates a new database. By default the database is created in Carbon store location, but you can also specify custom location.</p>
-<pre><code>CREATE DATABASE [IF NOT EXISTS] database_name [LOCATION path];
-</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?;
-</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>
-<h3>
-<a id="show-table" class="anchor" href="#show-table" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>SHOW TABLE</h3>
-<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>
-<p>Example:</p>
-<pre><code>SHOW TABLES
-OR
-SHOW TABLES IN defaultdb
-</code></pre>
-<h3>
-<a id="alter-table" class="anchor" href="#alter-table" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>ALTER TABLE</h3>
-<p>The following section introduce the commands to modify the physical or logical state of the existing table(s).</p>
-<ul>
-<li>
-<p><strong>RENAME TABLE</strong></p>
-<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>
-<p>Examples:</p>
-<pre><code>ALTER TABLE carbon RENAME TO carbonTable
-OR
-ALTER TABLE test_db.carbon RENAME TO test_db.carbonTable
-</code></pre>
-</li>
-<li>
-<p><strong>ADD COLUMNS</strong></p>
-<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,...',
-'DEFAULT.VALUE.COLUMN_NAME'='default_value')
-</code></pre>
-<p>Examples:</p>
-<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_INCLUDE'='a1')
-</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>
-</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>
-<ul>
-<li>
-<p><strong>DROP COLUMNS</strong></p>
-<p>This command is used to delete the existing column(s) in a table.</p>
-<pre><code>ALTER TABLE [db_name.]table_name DROP COLUMNS (col_name, ...)
-</code></pre>
-<p>Examples:</p>
-<pre><code>ALTER TABLE carbon DROP COLUMNS (b1)
-OR
-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>
-</li>
-<li>
-<p><strong>CHANGE DATA TYPE</strong></p>
-<p>This command is used to change the data type from INT to BIGINT or decimal precision from lower to higher.
-Change of decimal data type from lower precision to higher precision will only be supported for cases where there is no data loss.</p>
-<pre><code>ALTER TABLE [db_name.]table_name CHANGE col_name col_name changed_column_type
-</code></pre>
-<p>Valid Scenarios</p>
-<ul>
-<li>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.</li>
-<li>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.</li>
-<li>
-<strong>NOTE:</strong> The allowed range is 38,38 (precision, scale) and is a valid upper case scenario which is not resulting in data loss.</li>
-</ul>
-<p>Example1:Changing data type of column a1 from INT to BIGINT.</p>
-<pre><code>ALTER TABLE test_db.carbon CHANGE a1 a1 BIGINT
-</code></pre>
-<p>Example2:Changing decimal precision of column a1 from 10 to 18.</p>
-<pre><code>ALTER TABLE test_db.carbon CHANGE a1 a1 DECIMAL(18,2)
-</code></pre>
-</li>
-<li>
-<p><strong>MERGE INDEX</strong></p>
-<p>This command is used to merge all the CarbonData index files (.carbonindex) inside a segment to a single CarbonData index merge file (.carbonindexmerge). This enhances the first query performance.</p>
-<pre><code> ALTER TABLE [db_name.]table_name COMPACT 'SEGMENT_INDEX'
- ```
-
- Examples:
- ```
- ALTER TABLE test_db.carbon COMPACT 'SEGMENT_INDEX'
- ```
- **NOTE:**
- * Merge index is not supported on streaming table.
-
-</code></pre>
-</li>
-<li>
-<p><strong>SET and UNSET for Local Dictionary Properties</strong></p>
-<p>When set command is used, all the newly set properties will override the corresponding old properties if exists.</p>
-<p>Example to SET Local Dictionary Properties:</p>
-<pre><code>ALTER TABLE tablename SET TBLPROPERTIES('LOCAL_DICTIONARY_ENABLE'='false','LOCAL_DICTIONARY_THRESHOLD'='1000','LOCAL_DICTIONARY_INCLUDE'='column1','LOCAL_DICTIONARY_EXCLUDE'='column2')
-</code></pre>
-<p>When Local Dictionary properties are unset, corresponding default values will be used for these properties.</p>
-<p>Example to UNSET Local Dictionary Properties:</p>
-<pre><code>ALTER TABLE tablename UNSET TBLPROPERTIES('LOCAL_DICTIONARY_ENABLE','LOCAL_DICTIONARY_THRESHOLD','LOCAL_DICTIONARY_INCLUDE','LOCAL_DICTIONARY_EXCLUDE')
-</code></pre>
-<p><strong>NOTE:</strong> For old tables, by default, local dictionary is disabled. If user wants local dictionary for these tables, user can enable/disable local dictionary for new data at their discretion.
-This can be achieved by using the alter table set command.</p>
-</li>
-</ul>
-<h3>
-<a id="drop-table" class="anchor" href="#drop-table" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>DROP TABLE</h3>
-<p>This command is used to delete an existing table.</p>
-<pre><code>DROP TABLE [IF EXISTS] [db_name.]table_name
-</code></pre>
-<p>Example:</p>
-<pre><code>DROP TABLE IF EXISTS productSchema.productSalesTable
-</code></pre>
-<h3>
-<a id="refresh-table" class="anchor" href="#refresh-table" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>REFRESH TABLE</h3>
-<p>This command is used to register Carbon table to HIVE meta store catalogue from existing Carbon table data.</p>
-<pre><code>REFRESH TABLE $db_NAME.$table_NAME
-</code></pre>
-<p>Example:</p>
-<pre><code>REFRESH TABLE dbcarbon.productSalesTable
-</code></pre>
-<p><strong>NOTE:</strong></p>
-<ul>
-<li>The new database name and the old database name should be same.</li>
-<li>Before executing this command the old table schema and data should be copied into the new database location.</li>
-<li>If the table is aggregate table, then all the aggregate tables should be copied to the new database location.</li>
-<li>For old store, the time zone of the source and destination cluster should be same.</li>
-<li>If old cluster used HIVE meta store to store schema, refresh will not work as schema file does not exist in file system.</li>
-</ul>
-<h3>
-<a id="table-and-column-comment" class="anchor" href="#table-and-column-comment" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Table and Column Comment</h3>
-<p>You can provide more information on table by using table comment. Similarly you can provide more information about a particular column using column comment.
-You can see the column comment of an existing table using describe formatted command.</p>
-<pre><code>CREATE TABLE [IF NOT EXISTS] [db_name.]table_name[(col_name data_type [COMMENT col_comment], ...)]
- [COMMENT table_comment]
-STORED BY 'carbondata'
-[TBLPROPERTIES (property_name=property_value, ...)]
-</code></pre>
-<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?
- STORED BY 'carbondata'
- TBLPROPERTIES ('DICTIONARY_INCLUDE'='productNumber')
-</code></pre>
-<p>You can also SET and UNSET table comment using ALTER command.</p>
-<p>Example to SET table comment:</p>
-<pre><code>ALTER TABLE carbon SET TBLPROPERTIES ('comment'='this table comment is modified');
-</code></pre>
-<p>Example to UNSET table comment:</p>
-<pre><code>ALTER TABLE carbon UNSET TBLPROPERTIES ('comment');
-</code></pre>
-<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>
-<h3>
-<a id="load-files-to-carbondata-table" class="anchor" href="#load-files-to-carbondata-table" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>LOAD FILES TO CARBONDATA TABLE</h3>
-<p>This command is used to load csv files to carbondata, OPTIONS are not mandatory for data loading process.
-Inside OPTIONS user can provide any options like DELIMITER, QUOTECHAR, FILEHEADER, ESCAPECHAR, MULTILINE as per requirement.</p>
-<pre><code>LOAD DATA [LOCAL] INPATH 'folder_path'
-INTO TABLE [db_name.]table_name
-OPTIONS(property_name=property_value, ...)
-</code></pre>
-<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>HEADER:</strong> When you load the CSV file without the file header and the file header is the same with the table schema, then add 'HEADER'='false' to load data SQL as user need not provide the file header. By default the value is 'true'.
-false: CSV file is without file header.
-true: CSV file is with file header.</p>
-<pre><code>OPTIONS('HEADER'='false')
-</code></pre>
-<p><strong>NOTE:</strong> If the HEADER option exist and is set to 'true', then the FILEHEADER option is not required.</p>
-</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 in CSV files.</p>
-<pre><code>OPTIONS('ESCAPECHAR'='\')
-</code></pre>
-</li>
-<li>
-<p><strong>SKIP_EMPTY_LINE:</strong> This option will ignore the empty line in the CSV file during the data load.</p>
-<pre><code>OPTIONS('SKIP_EMPTY_LINE'='TRUE/FALSE')
-</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><strong>NOTE:</strong> ALL_DICTIONARY_PATH and COLUMNDICT can't be used together.</p>
-</li>
-<li>
-<p><strong>DATEFORMAT/TIMESTAMPFORMAT:</strong> Date and Timestamp format for specified column.</p>
-<pre><code>OPTIONS('DATEFORMAT' = 'yyyy-MM-dd','TIMESTAMPFORMAT'='yyyy-MM-dd HH:mm:ss')
-</code></pre>
-<p><strong>NOTE:</strong> 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 rel="nofollow">SimpleDateFormat</a>.</p>
-</li>
-<li>
-<p><strong>SORT COLUMN BOUNDS:</strong> 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>
-<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>
-<p><strong>NOTE:</strong></p>
-<ul>
-<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>Users can find more information about this option in the description of PR1953.</li>
-</ul>
-</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>
-</li>
-</ul>
-<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><strong>NOTE:</strong></p>
-<ul>
-<li>If this option is set to TRUE then data loading will take less time.</li>
-<li>If this option is set to some invalid value other than TRUE or FALSE then it uses the default value.</li>
-</ul>
-<p>Example:</p>
-<pre><code>LOAD DATA local inpath '/opt/rawdata/data.csv' INTO table carbontable
-options('DELIMITER'=',', 'QUOTECHAR'='"','COMMENTCHAR'='#',
-'HEADER'='false',
-'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>Load all of the data before dealing with the errors.</li>
-<li>Clean or delete bad records before loading data or stop the loading when bad records are found.</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>
-</li>
-</ul>
-<p><strong>NOTE:</strong></p>
-<ul>
-<li>BAD_RECORDS_ACTION property can have four type of actions for bad records FORCE, REDIRECT, IGNORE and FAIL.</li>
-<li>FAIL option is its Default value. If the FAIL option is used, then data loading fails if any bad records are found.</li>
-<li>If the REDIRECT option is used, CarbonData 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.</li>
-<li>If the FORCE option is used, then it auto-converts the data by storing the bad records as NULL before Loading data.</li>
-<li>If the IGNORE option is used, then bad records are neither loaded nor written to the separate CSV file.</li>
-<li>In loaded data, if all records are bad records, the BAD_RECORDS_ACTION is invalid and the load operation fails.</li>
-<li>The default maximum number of characters per column is 32000. If there are more than 32000 characters in a column, please refer to <em>String longer than 32000 characters</em> section.</li>
-<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></p>
-<p>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',
-'BAD_RECORDS_ACTION'='REDIRECT','IS_EMPTY_DATA_BAD_RECORD'='false')
-</code></pre>
-<ul>
-<li>
-<strong>GLOBAL_SORT_PARTITIONS:</strong> If the SORT_SCOPE is defined as GLOBAL_SORT, then user can specify the number of partitions to use while shuffling data for sort using GLOBAL_SORT_PARTITIONS. If it is not configured, or configured less than 1, then it uses the number of map task as reduce task. It is recommended that each reduce task deal with 512MB-1GB data.</li>
-</ul>
-<pre><code>OPTIONS('GLOBAL_SORT_PARTITIONS'='2')
-</code></pre>
-<p>NOTE:</p>
-<ul>
-<li>GLOBAL_SORT_PARTITIONS should be Integer type, the range is [1,Integer.MaxValue].</li>
-<li>It is only used when the SORT_SCOPE is GLOBAL_SORT.</li>
-</ul>
-<h3>
-<a id="insert-data-into-carbondata-table" class="anchor" href="#insert-data-into-carbondata-table" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>INSERT DATA INTO CARBONDATA TABLE</h3>
-<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>
-<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>
-<p>Overwrite insert data:</p>
-<pre><code>INSERT OVERWRITE TABLE <CARBONDATA TABLE> SELECT * FROM sourceTableName
-[ WHERE { <filter_condition> } ]
-</code></pre>
-<p><strong>NOTE:</strong></p>
-<ul>
-<li>The source table and the CarbonData table must have the same table schema.</li>
-<li>The data type of source and destination table columns should be same</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>Examples</p>
-<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 OVERWRITE TABLE table1 SELECT * FROM TABLE2
-</code></pre>
-<h2>
-<a id="update-and-delete" class="anchor" href="#update-and-delete" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>UPDATE AND DELETE</h2>
-<h3>
-<a id="update" class="anchor" href="#update" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>UPDATE</h3>
-<p>This command will allow to update the CarbonData table based on the column expression and optional filter conditions.</p>
-<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 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>
-<p><strong>NOTE:</strong> The update command fails if multiple input rows in source table are matched with single row in destination table.</p>
-<p>Examples:</p>
-<pre><code>UPDATE t3 SET (t3_salary) = (t3_salary + 9) WHERE t3_name = 'aaa1'
-</code></pre>
-<pre><code>UPDATE t3 SET (t3_date, t3_country) = ('2017-11-18', 'india') WHERE t3_salary < 15003
-</code></pre>
-<pre><code>UPDATE t3 SET (t3_country, t3_name) = (SELECT t5_country, t5_name FROM t5 WHERE t5_id = 5) WHERE t3_id < 5
-</code></pre>
-<pre><code>UPDATE t3 SET (t3_date, t3_serialname, t3_salary) = (SELECT '2099-09-09', t5_serialname, '9999' FROM t5 WHERE t5_id = 5) WHERE t3_id < 5
-</code></pre>
-<pre><code>UPDATE t3 SET (t3_country, t3_salary) = (SELECT t5_country, t5_salary FROM t5 FULL JOIN t3 u WHERE u.t3_id = t5_id and t5_id=6) WHERE t3_id >6
-</code></pre>
-<p>NOTE: Update Complex datatype columns is not supported.</p>
-<h3>
-<a id="delete" class="anchor" href="#delete" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>DELETE</h3>
-<p>This command allows us to delete records from CarbonData table.</p>
-<pre><code>DELETE FROM table_name [WHERE expression]
-</code></pre>
-<p>Examples:</p>
-<pre><code>DELETE FROM carbontable WHERE column1 = 'china'
-</code></pre>
-<pre><code>DELETE FROM carbontable WHERE column1 IN ('china', 'USA')
-</code></pre>
-<pre><code>DELETE FROM carbontable WHERE column1 IN (SELECT column11 FROM sourceTable2)
-</code></pre>
-<pre><code>DELETE FROM carbontable WHERE column1 IN (SELECT column11 FROM sourceTable2 WHERE column1 = 'USA')
-</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>Compaction improves the query performance significantly.</p>
-<p>There are several types of compaction.</p>
-<pre><code>ALTER TABLE [db_name.]table_name COMPACT 'MINOR/MAJOR/CUSTOM'
-</code></pre>
-<ul>
-<li><strong>Minor Compaction</strong></li>
-</ul>
-<p>In Minor compaction, user can specify the number of loads to be merged.
-Minor compaction triggers for every data load if the parameter carbon.enable.auto.load.merge is set to true.
-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 larger segment.</li>
-</ul>
-<pre><code>ALTER TABLE table_name COMPACT 'MINOR'
-</code></pre>
-<ul>
-<li><strong>Major Compaction</strong></li>
-</ul>
-<p>In Major compaction, multiple segments can be merged into one large segment.
-User will specify the compaction size until which segments can be merged, Major compaction is usually done during the off-peak time.
-Configure the property carbon.major.compaction.size with appropriate value in MB.</p>
-<p>This command merges the specified number of segments into one segment:</p>
-<pre><code>ALTER TABLE table_name COMPACT 'MAJOR'
-</code></pre>
-<ul>
-<li><strong>Custom Compaction</strong></li>
-</ul>
-<p>In Custom compaction, user can directly specify segment ids to be merged into one large segment.
-All specified segment ids should exist and be valid, otherwise compaction will fail.
-Custom compaction is usually done during the off-peak time.</p>
-<pre><code>ALTER TABLE table_name COMPACT 'CUSTOM' WHERE SEGMENT.ID IN (2,3,4)
-</code></pre>
-<p>NOTE: Compaction is unsupported for table containing Complex columns.</p>
-<ul>
-<li><strong>CLEAN SEGMENTS AFTER Compaction</strong></li>
-</ul>
-<p>Clean the segments which are compacted:</p>
-<pre><code>CLEAN FILES FOR TABLE carbon_table
-</code></pre>
-<h2>
-<a id="partition" class="anchor" href="#partition" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>PARTITION</h2>
-<h3>
-<a id="standard-partition" class="anchor" href="#standard-partition" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>STANDARD PARTITION</h3>
-<p>The partition is similar as spark and hive partition, user can use any column to build partition:</p>
-<h4>
-<a id="create-partition-table" class="anchor" href="#create-partition-table" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Create Partition Table</h4>
-<p>This command allows you to create table with partition.</p>
-<pre><code>CREATE TABLE [IF NOT EXISTS] [db_name.]table_name
- [(col_name data_type , ...)]
- [COMMENT table_comment]
- [PARTITIONED BY (col_name data_type , ...)]
- [STORED BY file_format]
- [TBLPROPERTIES (property_name=property_value, ...)]
-</code></pre>
-<p>Example:</p>
-<pre><code> CREATE TABLE IF NOT EXISTS productSchema.productSalesTable (
- productNumber INT,
- productName STRING,
- storeCity STRING,
- storeProvince STRING,
- saleQuantity INT,
- revenue INT)
-PARTITIONED BY (productCategory STRING, productBatch STRING)
-STORED BY 'carbondata'
-</code></pre>
-<p>NOTE: Hive partition is not supported on complex datatype columns.</p>
-<h4>
-<a id="load-data-using-static-partition" class="anchor" href="#load-data-using-static-partition" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Load Data Using Static Partition</h4>
-<p>This command allows you to load data using static partition.</p>
-<pre><code>LOAD DATA [LOCAL] INPATH 'folder_path'
-INTO TABLE [db_name.]table_name PARTITION (partition_spec)
-OPTIONS(property_name=property_value, ...)
-INSERT INTO INTO TABLE [db_name.]table_name PARTITION (partition_spec) <SELECT STATEMENT>
-</code></pre>
-<p>Example:</p>
-<pre><code>LOAD DATA LOCAL INPATH '${env:HOME}/staticinput.csv'
-INTO TABLE locationTable
-PARTITION (country = 'US', state = 'CA')
-INSERT INTO TABLE locationTable
-PARTITION (country = 'US', state = 'AL')
-SELECT <columns list excluding partition columns> FROM another_user
-</code></pre>
-<h4>
-<a id="load-data-using-dynamic-partition" class="anchor" href="#load-data-using-dynamic-partition" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Load Data Using Dynamic Partition</h4>
-<p>This command allows you to load data using dynamic partition. If partition spec is not specified, then the partition is considered as dynamic.</p>
-<p>Example:</p>
-<pre><code>LOAD DATA LOCAL INPATH '${env:HOME}/staticinput.csv'
-INTO TABLE locationTable
-INSERT INTO TABLE locationTable
-SELECT <columns list excluding partition columns> FROM another_user
-</code></pre>
-<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>
-<pre><code>SHOW PARTITIONS [db_name.]table_name
-</code></pre>
-<h4>
-<a id="drop-partition" class="anchor" href="#drop-partition" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Drop Partition</h4>
-<p>This command drops the specified Hive partition only.</p>
-<pre><code>ALTER TABLE table_name DROP [IF EXISTS] PARTITION (part_spec, ...)
-</code></pre>
-<p>Example:</p>
-<pre><code>ALTER TABLE locationTable DROP PARTITION (country = 'US');
-</code></pre>
-<h4>
-<a id="insert-overwrite" class="anchor" href="#insert-overwrite" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Insert OVERWRITE</h4>
-<p>This command allows you to insert or load overwrite on a specific partition.</p>
-<pre><code> INSERT OVERWRITE TABLE table_name
- PARTITION (column = 'partition_name')
- select_statement
-</code></pre>
-<p>Example:</p>
-<pre><code>INSERT OVERWRITE TABLE partitioned_user
-PARTITION (country = 'US')
-SELECT * FROM another_user au
-WHERE au.country = 'US';
-</code></pre>
-<h3>
-<a id="carbondata-partitionhashrangelist----alpha-feature-this-partition-feature-does-not-support-update-and-delete-data" class="anchor" href="#carbondata-partitionhashrangelist----alpha-feature-this-partition-feature-does-not-support-update-and-delete-data" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>CARBONDATA PARTITION(HASH,RANGE,LIST) -- Alpha feature, this partition feature does not support update and delete data.</h3>
-<p>The partition supports three type:(Hash,Range,List), similar to other system's partition features, CarbonData's partition feature can be used to improve query performance by filtering on the partition column.</p>
-<h3>
-<a id="create-hash-partition-table" class="anchor" href="#create-hash-partition-table" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Create Hash Partition Table</h3>
-<p>This command allows us to create hash partition.</p>
-<pre><code>CREATE TABLE [IF NOT EXISTS] [db_name.]table_name
- [(col_name data_type , ...)]
-PARTITIONED BY (partition_col_name data_type)
-STORED BY 'carbondata'
-[TBLPROPERTIES ('PARTITION_TYPE'='HASH',
- 'NUM_PARTITIONS'='N' ...)]
-</code></pre>
-<p><strong>NOTE:</strong> N is the number of hash partitions</p>
-<p>Example:</p>
-<pre><code>CREATE TABLE IF NOT EXISTS hash_partition_table(
- col_A STRING,
- col_B INT,
- col_C LONG,
- col_D DECIMAL(10,2),
- col_F TIMESTAMP
-) PARTITIONED BY (col_E LONG)
-STORED BY 'carbondata' TBLPROPERTIES('PARTITION_TYPE'='HASH','NUM_PARTITIONS'='9')
-</code></pre>
-<h3>
-<a id="create-range-partition-table" class="anchor" href="#create-range-partition-table" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Create Range Partition Table</h3>
-<p>This command allows us to create range partition.</p>
-<pre><code>CREATE TABLE [IF NOT EXISTS] [db_name.]table_name
- [(col_name data_type , ...)]
-PARTITIONED BY (partition_col_name data_type)
-STORED BY 'carbondata'
-[TBLPROPERTIES ('PARTITION_TYPE'='RANGE',
- 'RANGE_INFO'='2014-01-01, 2015-01-01, 2016-01-01, ...')]
-</code></pre>
-<p><strong>NOTE:</strong></p>
-<ul>
-<li>The 'RANGE_INFO' must be defined in ascending order in the table properties.</li>
-<li>The default format for partition column of Date/Timestamp type is yyyy-MM-dd. Alternate formats for Date/Timestamp could be defined in CarbonProperties.</li>
-</ul>
-<p>Example:</p>
-<pre><code>CREATE TABLE IF NOT EXISTS range_partition_table(
- col_A STRING,
- col_B INT,
- col_C LONG,
- col_D DECIMAL(10,2),
- col_E LONG
- ) partitioned by (col_F Timestamp)
- PARTITIONED BY 'carbondata'
- TBLPROPERTIES('PARTITION_TYPE'='RANGE',
- 'RANGE_INFO'='2015-01-01, 2016-01-01, 2017-01-01, 2017-02-01')
-</code></pre>
-<h3>
-<a id="create-list-partition-table" class="anchor" href="#create-list-partition-table" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Create List Partition Table</h3>
-<p>This command allows us to create list partition.</p>
-<pre><code>CREATE TABLE [IF NOT EXISTS] [db_name.]table_name
- [(col_name data_type , ...)]
-PARTITIONED BY (partition_col_name data_type)
-STORED BY 'carbondata'
-[TBLPROPERTIES ('PARTITION_TYPE'='LIST',
- 'LIST_INFO'='A, B, C, ...')]
-</code></pre>
-<p><strong>NOTE:</strong> List partition supports list info in one level group.</p>
-<p>Example:</p>
-<pre><code>CREATE TABLE IF NOT EXISTS list_partition_table(
- col_B INT,
- col_C LONG,
- col_D DECIMAL(10,2),
- col_E LONG,
- col_F TIMESTAMP
- ) PARTITIONED BY (col_A STRING)
- STORED BY 'carbondata'
- TBLPROPERTIES('PARTITION_TYPE'='LIST',
- 'LIST_INFO'='aaaa, bbbb, (cccc, dddd), eeee')
-</code></pre>
-<h3>
-<a id="show-partitions-1" class="anchor" href="#show-partitions-1" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Show Partitions</h3>
-<p>The following command is executed to get the partition information of the table</p>
-<pre><code>SHOW PARTITIONS [db_name.]table_name
-</code></pre>
-<h3>
-<a id="add-a-new-partition" class="anchor" href="#add-a-new-partition" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Add a new partition</h3>
-<pre><code>ALTER TABLE [db_name].table_name ADD PARTITION('new_partition')
-</code></pre>
-<h3>
-<a id="split-a-partition" class="anchor" href="#split-a-partition" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Split a partition</h3>
-<pre><code>ALTER TABLE [db_name].table_name SPLIT PARTITION(partition_id) INTO('new_partition1', 'new_partition2'...)
-</code></pre>
-<h3>
-<a id="drop-a-partition" class="anchor" href="#drop-a-partition" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Drop a partition</h3>
-<p>Only drop partition definition, but keep data</p>
-<pre><code> ALTER TABLE [db_name].table_name DROP PARTITION(partition_id)
-</code></pre>
-<p>Drop both partition definition and data</p>
-<pre><code>ALTER TABLE [db_name].table_name DROP PARTITION(partition_id) WITH DATA
-</code></pre>
-<p><strong>NOTE:</strong></p>
-<ul>
-<li>Hash partition table is not supported for ADD, SPLIT and DROP commands.</li>
-<li>Partition Id: in CarbonData like the hive, folders are not used to divide partitions instead partition id is used to replace the task id. It could make use of the characteristic and meanwhile reduce some metadata.</li>
-</ul>
-<pre><code>SegmentDir/0_batchno0-0-1502703086921.carbonindex
- ^
-SegmentDir/part-0-0_batchno0-0-1502703086921.carbondata
- ^
-</code></pre>
-<p>Here are some useful tips to improve query performance of carbonData partition table:</p>
-<ul>
-<li>The partitioned column can be excluded from SORT_COLUMNS, this will let other columns to do the efficient sorting.</li>
-<li>When writing SQL on a partition table, try to use filters on the partition column.</li>
-</ul>
-<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, 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>
-<p><strong>NOTE:</strong></p>
-<ul>
-<li>Bucketing cannot be performed for columns of Complex Data Types.</li>
-<li>Columns in the BUCKETCOLUMN parameter must be dimensions. The BUCKETCOLUMN parameter cannot be a measure or a combination of measures and dimensions.</li>
-</ul>
-<p>Example:</p>
-<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 ('BUCKETNUMBER'='4', 'BUCKETCOLUMNS'='productName')
-</code></pre>
-<h2>
-<a id="segment-management" class="anchor" href="#segment-management" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>SEGMENT MANAGEMENT</h2>
-<h3>
-<a id="show-segment" class="anchor" href="#show-segment" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>SHOW SEGMENT</h3>
-<p>This command is used to list the segments of CarbonData table.</p>
-<pre><code>SHOW [HISTORY] SEGMENTS FOR TABLE [db_name.]table_name LIMIT number_of_segments
-</code></pre>
-<p>Example:
-Show visible segments</p>
-<pre><code>SHOW SEGMENTS FOR TABLE CarbonDatabase.CarbonTable LIMIT 4
-</code></pre>
-<p>Show all segments, include invisible segments</p>
-<pre><code>SHOW HISTORY SEGMENTS FOR TABLE CarbonDatabase.CarbonTable LIMIT 4
-</code></pre>
-<h3>
-<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</h3>
-<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>
-<p>Example:</p>
-<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>
-<h3>
-<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</h3>
-<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>
-<p>Example:</p>
-<pre><code>DELETE FROM TABLE CarbonDatabase.CarbonTable WHERE SEGMENT.STARTTIME BEFORE '2017-06-01 12:05:06'
-</code></pre>
-<h3>
-<a id="query-data-with-specified-segments" class="anchor" href="#query-data-with-specified-segments" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>QUERY DATA WITH SPECIFIED SEGMENTS</h3>
-<p>This command is used to read data from specified segments during CarbonScan.</p>
-<p>Get the Segment ID:</p>
-<pre><code>SHOW SEGMENTS FOR TABLE [db_name.]table_name LIMIT number_of_segments
-</code></pre>
-<p>Set the segment IDs for table</p>
-<pre><code>SET carbon.input.segments.<database_name>.<table_name> = <list of segment IDs>
-</code></pre>
-<p><strong>NOTE:</strong>
-carbon.input.segments: Specifies the segment IDs to be queried. This property allows you to query specified segments of the specified table. The CarbonScan will read data from specified segments only.</p>
-<p>If user wants to query with segments reading in multi threading mode, then CarbonSession. threadSet can be used instead of SET query.</p>
-<pre><code>CarbonSession.threadSet ("carbon.input.segments.<database_name>.<table_name>","<list of segment IDs>");
-</code></pre>
-<p>Reset the segment IDs</p>
-<pre><code>SET carbon.input.segments.<database_name>.<table_name> = *;
-</code></pre>
-<p>If user wants to query with segments reading in multi threading mode, then CarbonSession. threadSet can be used instead of SET query.</p>
-<pre><code>CarbonSession.threadSet ("carbon.input.segments.<database_name>.<table_name>","*");
-</code></pre>
-<p><strong>Examples:</strong></p>
-<ul>
-<li>Example to show the list of segment IDs,segment status, and other required details and then specify the list of segments to be read.</li>
-</ul>
-<pre><code>SHOW SEGMENTS FOR carbontable1;
-
-SET carbon.input.segments.db.carbontable1 = 1,3,9;
-</code></pre>
-<ul>
-<li>Example to query with segments reading in multi threading mode:</li>
-</ul>
-<pre><code>CarbonSession.threadSet ("carbon.input.segments.db.carbontable_Multi_Thread","1,3");
-</code></pre>
-<ul>
-<li>Example for threadset in multithread environment (following shows how it is used in Scala code):</li>
-</ul>
-<pre><code>def main(args: Array[String]) {
-Future {
- CarbonSession.threadSet ("carbon.input.segments.db.carbontable_Multi_Thread","1")
- spark.sql("select count(empno) from carbon.input.segments.db.carbontable_Multi_Thread").show();
- }
- }
-</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
[20/20] carbondata-site git commit: Updated changes for 1.5.0 release
Posted by ch...@apache.org.
Updated changes for 1.5.0 release
Project: http://git-wip-us.apache.org/repos/asf/carbondata-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/carbondata-site/commit/6f8949f1
Tree: http://git-wip-us.apache.org/repos/asf/carbondata-site/tree/6f8949f1
Diff: http://git-wip-us.apache.org/repos/asf/carbondata-site/diff/6f8949f1
Branch: refs/heads/asf-site
Commit: 6f8949f113f3ab35e25cb62b7509b0f569fe86d5
Parents: 07526d0
Author: chenliang613 <ch...@huawei.com>
Authored: Wed Oct 17 18:14:43 2018 +0800
Committer: chenliang613 <ch...@huawei.com>
Committed: Wed Oct 17 18:14:43 2018 +0800
----------------------------------------------------------------------
content/data-management-on-carbondata.html | 1321 +++++++++++++++++++++++
content/data-management.html | 413 +++++++
content/ddl-operation-on-carbondata.html | 748 +++++++++++++
content/dml-operation-on-carbondata.html | 716 ++++++++++++
content/installation-guide.html | 455 ++++++++
content/mainpage.html | 214 ++++
content/sdk-writer-guide.html | 549 ++++++++++
content/troubleshooting.html | 366 +++++++
content/useful-tips-on-carbondata.html | 480 ++++++++
9 files changed, 5262 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6f8949f1/content/data-management-on-carbondata.html
----------------------------------------------------------------------
diff --git a/content/data-management-on-carbondata.html b/content/data-management-on-carbondata.html
new file mode 100644
index 0000000..566bb8e
--- /dev/null
+++ b/content/data-management-on-carbondata.html
@@ -0,0 +1,1321 @@
+<!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.4.1/"
+ target="_blank">Apache CarbonData 1.4.1</a></li>
+ <li>
+ <a href="https://dist.apache.org/repos/dist/release/carbondata/1.4.0/"
+ target="_blank">Apache CarbonData 1.4.0</a></li>
+ <li>
+ <a href="https://dist.apache.org/repos/dist/release/carbondata/1.3.1/"
+ target="_blank">Apache CarbonData 1.3.1</a></li>
+ <li>
+ <a href="https://dist.apache.org/repos/dist/release/carbondata/1.3.0/"
+ target="_blank">Apache CarbonData 1.3.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-on-carbondata" class="anchor" href="#data-management-on-carbondata" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Data Management on CarbonData</h1>
+<p>This tutorial is going to introduce all commands and data operations on CarbonData.</p>
+<ul>
+<li><a href="#create-table">CREATE TABLE</a></li>
+<li><a href="#create-database">CREATE DATABASE</a></li>
+<li><a href="#table-management">TABLE MANAGEMENT</a></li>
+<li><a href="#load-data">LOAD DATA</a></li>
+<li><a href="#update-and-delete">UPDATE AND DELETE</a></li>
+<li><a href="#compaction">COMPACTION</a></li>
+<li><a href="#partition">PARTITION</a></li>
+<li><a href="#bucketing">BUCKETING</a></li>
+<li><a href="#segment-management">SEGMENT MANAGEMENT</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. You can also specify the location where the table needs to be stored.</p>
+<pre><code>CREATE TABLE [IF NOT EXISTS] [db_name.]table_name[(col_name data_type , ...)]
+STORED AS carbondata
+[TBLPROPERTIES (property_name=property_value, ...)]
+[LOCATION 'path']
+</code></pre>
+<p><strong>NOTE:</strong> CarbonData also supports "STORED AS carbondata" and "USING carbondata". Find example code at <a href="https://github.com/apache/carbondata/blob/master/examples/spark2/src/main/scala/org/apache/carbondata/examples/CarbonSessionExample.scala" target=_blank>CarbonSessionExample</a> in the CarbonData repo.</p>
+<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 TBLPROPERTIES, CarbonData's additional table options can be set via carbon.properties.</p>
+<ul>
+<li>
+<p><strong>Dictionary Encoding Configuration</strong></p>
+<p>Dictionary encoding is turned off for all columns by default from 1.3 onwards, you can use this command for including or excluding columns to do dictionary encoding.
+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>NOTE: Dictionary Include/Exclude for complex child columns is not supported.</p>
+</li>
+<li>
+<p><strong>Inverted Index Configuration</strong></p>
+<p>By default inverted index is enabled, it might help to improve compression ratio and query speed, especially for low cardinality columns which are in reward position.
+Suggested use cases : For high cardinality columns, you can disable the inverted index for improving the data loading performance.</p>
+<pre><code>TBLPROPERTIES ('NO_INVERTED_INDEX'='column1, column3')
+</code></pre>
+</li>
+<li>
+<p><strong>Sort Columns Configuration</strong></p>
+<p>This property is for users to specify which columns belong to the MDK(Multi-Dimensions-Key) index.</p>
+<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.
+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>
+</li>
+<li>
+<p><strong>Sort Scope Configuration</strong></p>
+<p>This property is for users to specify the scope of the sort during data load, following are the types of sort scope.</p>
+<ul>
+<li>LOCAL_SORT: It is the default sort scope.</li>
+<li>NO_SORT: It will load the data in unsorted manner, it will significantly increase load performance.</li>
+<li>BATCH_SORT: It increases the load performance but decreases the query performance if identified blocks > parallelism.</li>
+<li>GLOBAL_SORT: It increases the query performance, especially high concurrent point query.
+And if you care about loading resources isolation strictly, because the system uses the spark GroupBy to sort data, the resource can be controlled by spark.</li>
+</ul>
+</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 BY '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>
+<p><strong>Table Block Size Configuration</strong></p>
+<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>
+<pre><code>TBLPROPERTIES ('TABLE_BLOCKSIZE'='512')
+</code></pre>
+<p><strong>NOTE:</strong> 512 or 512M both are accepted.</p>
+</li>
+<li>
+<p><strong>Table Compaction Configuration</strong></p>
+<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>
+<ul>
+<li>MAJOR_COMPACTION_SIZE: same meaning as carbon.major.compaction.size, size in MB.</li>
+<li>AUTO_LOAD_MERGE: same meaning as carbon.enable.auto.load.merge.</li>
+<li>COMPACTION_LEVEL_THRESHOLD: same meaning as carbon.compaction.level.threshold.</li>
+<li>COMPACTION_PRESERVE_SEGMENTS: same meaning as carbon.numberof.preserve.segments.</li>
+<li>ALLOWED_COMPACTION_DAYS: same meaning as carbon.allowed.compaction.days.</li>
+</ul>
+<pre><code>TBLPROPERTIES ('MAJOR_COMPACTION_SIZE'='2048',
+ 'AUTO_LOAD_MERGE'='true',
+ 'COMPACTION_LEVEL_THRESHOLD'='5,6',
+ 'COMPACTION_PRESERVE_SEGMENTS'='10',
+ 'ALLOWED_COMPACTION_DAYS'='5')
+</code></pre>
+</li>
+<li>
+<p><strong>Streaming</strong></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>
+<li>
+<p><strong>Local Dictionary Configuration</strong></p>
+</li>
+</ul>
+<p>Columns for which dictionary is not generated needs more storage space and in turn more IO. Also since more data will have to be read during query, query performance also would suffer.Generating dictionary per blocklet for such columns would help in saving storage space and assist in improving query performance as carbondata is optimized for handling dictionary encoded columns more effectively.Generating dictionary internally per blocklet is termed as local dictionary. Please refer to <a href="../file-structure-of-carbondata.html">File structure of Carbondata</a> for understanding about the file structure of carbondata and meaning of terms like blocklet.</p>
+<p>Local Dictionary helps in:</p>
+<ol>
+<li>Getting more compression.</li>
+<li>Filter queries and full scan queries will be faster as filter will be done on encoded data.</li>
+<li>Reducing the store size and memory footprint as only unique values will be stored as part of local dictionary and corresponding data will be stored as encoded data.</li>
+<li>Getting higher IO throughput.</li>
+</ol>
+<p><strong>NOTE:</strong></p>
+<ul>
+<li>
+<p>Following Data Types are Supported for Local Dictionary:</p>
+<ul>
+<li>STRING</li>
+<li>VARCHAR</li>
+<li>CHAR</li>
+</ul>
+</li>
+<li>
+<p>Following Data Types are not Supported for Local Dictionary:</p>
+<ul>
+<li>SMALLINT</li>
+<li>INTEGER</li>
+<li>BIGINT</li>
+<li>DOUBLE</li>
+<li>DECIMAL</li>
+<li>TIMESTAMP</li>
+<li>DATE</li>
+<li>BOOLEAN</li>
+</ul>
+</li>
+<li>
+<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 system property 'carbon.local.dictionary.enable'. By default, Local Dictionary will be disabled for the carbondata table.</p>
+<p>Local Dictionary can be configured using the following properties during create table command:</p>
+<table>
+<thead>
+<tr>
+<th>Properties</th>
+<th>Default value</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>LOCAL_DICTIONARY_ENABLE</td>
+<td>false</td>
+<td>Whether to enable local dictionary generation. <strong>NOTE:</strong> If this property is defined, it will override the value configured at system level by 'carbon.local.dictionary.enable'</td>
+</tr>
+<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>
+</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.</td>
+</tr>
+<tr>
+<td>LOCAL_DICTIONARY_EXCLUDE</td>
+<td>none</td>
+<td>Columns for which Local Dictionary need not be generated.</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>
+</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>
+<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>
+<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(
+
+ column1 string,
+
+ column2 string,
+
+ column3 LONG )
+
+ STORED BY 'carbondata'
+ TBLPROPERTIES('LOCAL_DICTIONARY_ENABLE'='true','LOCAL_DICTIONARY_THRESHOLD'='1000',
+ 'LOCAL_DICTIONARY_INCLUDE'='column1','LOCAL_DICTIONARY_EXCLUDE'='column2')
+</code></pre>
+<p><strong>NOTE:</strong></p>
+<ul>
+<li>We recommend to use Local Dictionary when cardinality is high but is distributed across multiple loads</li>
+<li>On a large cluster, decoding data can become a bottleneck for global dictionary as there will be many remote reads. In this scenario, it is better to use Local Dictionary.</li>
+<li>When cardinality is less, but loads are repetitive, it is better to use global dictionary as local dictionary generates multiple dictionary files at blocklet level increasing redundancy.</li>
+</ul>
+<ul>
+<li>
+<p><strong>Caching Min/Max Value for Required Columns</strong>
+By default, CarbonData caches min and max values of all the columns in schema. As the load increases, the memory required to hold the min and max values increases considerably. This feature enables you to configure min and max values only for the required columns, resulting in optimized memory usage.</p>
+<p>Following are the valid values for COLUMN_META_CACHE:</p>
+<ul>
+<li>If you want no column min/max values to be cached in the driver.</li>
+</ul>
+<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?
+</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,??
+</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,??)
+</code></pre>
+<p>Example:</p>
+<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,??)
+</code></pre>
+<p>Example:</p>
+<pre><code>ALTER TABLE employee SET TBLPROPERTIES (?COLUMN_META_CACHE?=?city?)
+</code></pre>
+</li>
+<li>
+<p><strong>Caching at Block or Blocklet Level</strong></p>
+<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?
+</code></pre>
+<p><em>Configuration for caching in driver at Blocklet level.</em></p>
+<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?)
+</code></pre>
+<p>Example:</p>
+<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?)
+</code></pre>
+<p>Example:</p>
+<pre><code>ALTER TABLE employee SET TBLPROPERTIES (?CACHE_LEVEL?=?Blocklet?)
+</code></pre>
+</li>
+</ul>
+<pre><code>- **Support Flat folder same as Hive/Parquet**
+
+ 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.
+
+ Following table property enables this feature and default value is false.
+ ```
+ 'flat_folder'='true'
+ ```
+ Example:
+ ```
+ CREATE TABLE employee (name String, city String, id int) STORED BY ?carbondata? TBLPROPERTIES ('flat_folder'='true')
+ ```
+
+- **String longer than 32000 characters**
+
+ In common scenarios, the length of string is less than 32000,
+ so carbondata stores the length of content using Short to reduce memory and space consumption.
+ To support string longer than 32000 characters, carbondata introduces a table property called `LONG_STRING_COLUMNS`.
+ For these columns, carbondata internally stores the length of content using Integer.
+
+ You can specify the columns as 'long string column' using below tblProperties:
+
+ ```
+ // specify col1, col2 as long string columns
+ TBLPROPERTIES ('LONG_STRING_COLUMNS'='col1,col2')
+ ```
+
+ Besides, you can also use this property through DataFrame by
+ ```
+ df.format("carbondata")
+ .option("tableName", "carbonTable")
+ .option("long_string_columns", "col1, col2")
+ .save()
+ ```
+
+ If you are using Carbon-SDK, you can specify the datatype of long string column as `varchar`.
+ You can refer to SDKwriterTestCase for example.
+
+ **NOTE:** The LONG_STRING_COLUMNS can only be string/char/varchar columns and cannot be dictionary_include/sort_columns/complex columns.
+</code></pre>
+<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>
+<p>This function allows user to create a Carbon table from any of the Parquet/Hive/Carbon table. This is beneficial when the user wants to create Carbon table from any other Parquet/Hive table and use the Carbon query engine to query and achieve better query results for cases where Carbon is faster than other file formats. Also this feature can be used for backing up the data.</p>
+<pre><code>CREATE TABLE [IF NOT EXISTS] [db_name.]table_name
+STORED BY 'carbondata'
+[TBLPROPERTIES (key1=val1, key2=val2, ...)]
+AS select_statement;
+</code></pre>
+<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>carbon.sql("CREATE TABLE source_table(
+ id INT,
+ name STRING,
+ city STRING,
+ age INT)
+ STORED AS parquet")
+carbon.sql("INSERT INTO source_table SELECT 1,'bob','shenzhen',27")
+carbon.sql("INSERT INTO source_table SELECT 2,'david','shenzhen',31")
+
+carbon.sql("CREATE TABLE target_table
+ STORED BY 'carbondata'
+ AS SELECT city,avg(age) FROM source_table GROUP BY city")
+
+carbon.sql("SELECT * FROM target_table").show
+ // results:
+ // +--------+--------+
+ // | city|avg(age)|
+ // +--------+--------+
+ // |shenzhen| 29.0|
+ // +--------+--------+
+
+</code></pre>
+<h2>
+<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 BY '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>
+<p>Managed table data location provided will have both FACT and Metadata folder.
+This data can be generated by creating a normal carbon table and use this path as $FilesPath in the above syntax.</p>
+<p><strong>Example:</strong></p>
+<pre><code>sql("CREATE TABLE origin(key INT, value STRING) STORED BY 'carbondata'")
+sql("INSERT INTO origin select 100,'spark'")
+sql("INSERT INTO origin select 200,'hive'")
+// creates a table in $storeLocation/origin
+
+sql(s"""
+|CREATE EXTERNAL TABLE source
+|STORED BY 'carbondata'
+|LOCATION '$storeLocation/origin'
+""".stripMargin)
+checkAnswer(sql("SELECT count(*) from source"), sql("SELECT count(*) from origin"))
+</code></pre>
+<h3>
+<a id="create-external-table-on-non-transactional-table-data-location" class="anchor" href="#create-external-table-on-non-transactional-table-data-location" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Create external table on Non-Transactional table data location.</h3>
+<p>Non-Transactional table data location will have only carbondata and carbonindex files, there will not be a metadata folder (table status and schema).
+Our SDK module currently support writing data in this format.</p>
+<p><strong>Example:</strong></p>
+<pre><code>sql(
+s"""CREATE EXTERNAL TABLE sdkOutputTable STORED BY 'carbondata' LOCATION
+|'$writerPath' """.stripMargin)
+</code></pre>
+<p>Here writer path will have carbondata and index files.
+This can be SDK output. Refer <a href="https://github.com/apache/carbondata/blob/master/docs/sdk-writer-guide.html" target=_blank>SDK Writer Guide</a>.</p>
+<p><strong>Note:</strong></p>
+<ol>
+<li>Dropping of the external table should not delete the files present in the location.</li>
+<li>When external table is created on non-transactional table data,
+external table will be registered with the schema of carbondata files.
+If multiple files with different schema is present, exception will be thrown.
+So, If table registered with one schema and files are of different schema,
+suggest to drop the external table and create again to register table with new schema.</li>
+</ol>
+<h2>
+<a id="create-database" class="anchor" href="#create-database" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>CREATE DATABASE</h2>
+<p>This function creates a new database. By default the database is created in Carbon store location, but you can also specify custom location.</p>
+<pre><code>CREATE DATABASE [IF NOT EXISTS] database_name [LOCATION path];
+</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?;
+</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>
+<h3>
+<a id="show-table" class="anchor" href="#show-table" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>SHOW TABLE</h3>
+<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>
+<p>Example:</p>
+<pre><code>SHOW TABLES
+OR
+SHOW TABLES IN defaultdb
+</code></pre>
+<h3>
+<a id="alter-table" class="anchor" href="#alter-table" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>ALTER TABLE</h3>
+<p>The following section introduce the commands to modify the physical or logical state of the existing table(s).</p>
+<ul>
+<li>
+<p><strong>RENAME TABLE</strong></p>
+<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>
+<p>Examples:</p>
+<pre><code>ALTER TABLE carbon RENAME TO carbonTable
+OR
+ALTER TABLE test_db.carbon RENAME TO test_db.carbonTable
+</code></pre>
+</li>
+<li>
+<p><strong>ADD COLUMNS</strong></p>
+<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,...',
+'DEFAULT.VALUE.COLUMN_NAME'='default_value')
+</code></pre>
+<p>Examples:</p>
+<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_INCLUDE'='a1')
+</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>
+</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>
+<ul>
+<li>
+<p><strong>DROP COLUMNS</strong></p>
+<p>This command is used to delete the existing column(s) in a table.</p>
+<pre><code>ALTER TABLE [db_name.]table_name DROP COLUMNS (col_name, ...)
+</code></pre>
+<p>Examples:</p>
+<pre><code>ALTER TABLE carbon DROP COLUMNS (b1)
+OR
+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>
+</li>
+<li>
+<p><strong>CHANGE DATA TYPE</strong></p>
+<p>This command is used to change the data type from INT to BIGINT or decimal precision from lower to higher.
+Change of decimal data type from lower precision to higher precision will only be supported for cases where there is no data loss.</p>
+<pre><code>ALTER TABLE [db_name.]table_name CHANGE col_name col_name changed_column_type
+</code></pre>
+<p>Valid Scenarios</p>
+<ul>
+<li>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.</li>
+<li>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.</li>
+<li>
+<strong>NOTE:</strong> The allowed range is 38,38 (precision, scale) and is a valid upper case scenario which is not resulting in data loss.</li>
+</ul>
+<p>Example1:Changing data type of column a1 from INT to BIGINT.</p>
+<pre><code>ALTER TABLE test_db.carbon CHANGE a1 a1 BIGINT
+</code></pre>
+<p>Example2:Changing decimal precision of column a1 from 10 to 18.</p>
+<pre><code>ALTER TABLE test_db.carbon CHANGE a1 a1 DECIMAL(18,2)
+</code></pre>
+</li>
+<li>
+<p><strong>MERGE INDEX</strong></p>
+<p>This command is used to merge all the CarbonData index files (.carbonindex) inside a segment to a single CarbonData index merge file (.carbonindexmerge). This enhances the first query performance.</p>
+<pre><code> ALTER TABLE [db_name.]table_name COMPACT 'SEGMENT_INDEX'
+ ```
+
+ Examples:
+ ```
+ ALTER TABLE test_db.carbon COMPACT 'SEGMENT_INDEX'
+ ```
+ **NOTE:**
+ * Merge index is not supported on streaming table.
+
+</code></pre>
+</li>
+<li>
+<p><strong>SET and UNSET for Local Dictionary Properties</strong></p>
+<p>When set command is used, all the newly set properties will override the corresponding old properties if exists.</p>
+<p>Example to SET Local Dictionary Properties:</p>
+<pre><code>ALTER TABLE tablename SET TBLPROPERTIES('LOCAL_DICTIONARY_ENABLE'='false','LOCAL_DICTIONARY_THRESHOLD'='1000','LOCAL_DICTIONARY_INCLUDE'='column1','LOCAL_DICTIONARY_EXCLUDE'='column2')
+</code></pre>
+<p>When Local Dictionary properties are unset, corresponding default values will be used for these properties.</p>
+<p>Example to UNSET Local Dictionary Properties:</p>
+<pre><code>ALTER TABLE tablename UNSET TBLPROPERTIES('LOCAL_DICTIONARY_ENABLE','LOCAL_DICTIONARY_THRESHOLD','LOCAL_DICTIONARY_INCLUDE','LOCAL_DICTIONARY_EXCLUDE')
+</code></pre>
+<p><strong>NOTE:</strong> For old tables, by default, local dictionary is disabled. If user wants local dictionary for these tables, user can enable/disable local dictionary for new data at their discretion.
+This can be achieved by using the alter table set command.</p>
+</li>
+</ul>
+<h3>
+<a id="drop-table" class="anchor" href="#drop-table" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>DROP TABLE</h3>
+<p>This command is used to delete an existing table.</p>
+<pre><code>DROP TABLE [IF EXISTS] [db_name.]table_name
+</code></pre>
+<p>Example:</p>
+<pre><code>DROP TABLE IF EXISTS productSchema.productSalesTable
+</code></pre>
+<h3>
+<a id="refresh-table" class="anchor" href="#refresh-table" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>REFRESH TABLE</h3>
+<p>This command is used to register Carbon table to HIVE meta store catalogue from existing Carbon table data.</p>
+<pre><code>REFRESH TABLE $db_NAME.$table_NAME
+</code></pre>
+<p>Example:</p>
+<pre><code>REFRESH TABLE dbcarbon.productSalesTable
+</code></pre>
+<p><strong>NOTE:</strong></p>
+<ul>
+<li>The new database name and the old database name should be same.</li>
+<li>Before executing this command the old table schema and data should be copied into the new database location.</li>
+<li>If the table is aggregate table, then all the aggregate tables should be copied to the new database location.</li>
+<li>For old store, the time zone of the source and destination cluster should be same.</li>
+<li>If old cluster used HIVE meta store to store schema, refresh will not work as schema file does not exist in file system.</li>
+</ul>
+<h3>
+<a id="table-and-column-comment" class="anchor" href="#table-and-column-comment" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Table and Column Comment</h3>
+<p>You can provide more information on table by using table comment. Similarly you can provide more information about a particular column using column comment.
+You can see the column comment of an existing table using describe formatted command.</p>
+<pre><code>CREATE TABLE [IF NOT EXISTS] [db_name.]table_name[(col_name data_type [COMMENT col_comment], ...)]
+ [COMMENT table_comment]
+STORED BY 'carbondata'
+[TBLPROPERTIES (property_name=property_value, ...)]
+</code></pre>
+<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?
+ STORED BY 'carbondata'
+ TBLPROPERTIES ('DICTIONARY_INCLUDE'='productNumber')
+</code></pre>
+<p>You can also SET and UNSET table comment using ALTER command.</p>
+<p>Example to SET table comment:</p>
+<pre><code>ALTER TABLE carbon SET TBLPROPERTIES ('comment'='this table comment is modified');
+</code></pre>
+<p>Example to UNSET table comment:</p>
+<pre><code>ALTER TABLE carbon UNSET TBLPROPERTIES ('comment');
+</code></pre>
+<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>
+<h3>
+<a id="load-files-to-carbondata-table" class="anchor" href="#load-files-to-carbondata-table" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>LOAD FILES TO CARBONDATA TABLE</h3>
+<p>This command is used to load csv files to carbondata, OPTIONS are not mandatory for data loading process.
+Inside OPTIONS user can provide any options like DELIMITER, QUOTECHAR, FILEHEADER, ESCAPECHAR, MULTILINE as per requirement.</p>
+<pre><code>LOAD DATA [LOCAL] INPATH 'folder_path'
+INTO TABLE [db_name.]table_name
+OPTIONS(property_name=property_value, ...)
+</code></pre>
+<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>HEADER:</strong> When you load the CSV file without the file header and the file header is the same with the table schema, then add 'HEADER'='false' to load data SQL as user need not provide the file header. By default the value is 'true'.
+false: CSV file is without file header.
+true: CSV file is with file header.</p>
+<pre><code>OPTIONS('HEADER'='false')
+</code></pre>
+<p><strong>NOTE:</strong> If the HEADER option exist and is set to 'true', then the FILEHEADER option is not required.</p>
+</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 in CSV files.</p>
+<pre><code>OPTIONS('ESCAPECHAR'='\')
+</code></pre>
+</li>
+<li>
+<p><strong>SKIP_EMPTY_LINE:</strong> This option will ignore the empty line in the CSV file during the data load.</p>
+<pre><code>OPTIONS('SKIP_EMPTY_LINE'='TRUE/FALSE')
+</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><strong>NOTE:</strong> ALL_DICTIONARY_PATH and COLUMNDICT can't be used together.</p>
+</li>
+<li>
+<p><strong>DATEFORMAT/TIMESTAMPFORMAT:</strong> Date and Timestamp format for specified column.</p>
+<pre><code>OPTIONS('DATEFORMAT' = 'yyyy-MM-dd','TIMESTAMPFORMAT'='yyyy-MM-dd HH:mm:ss')
+</code></pre>
+<p><strong>NOTE:</strong> 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 rel="nofollow">SimpleDateFormat</a>.</p>
+</li>
+<li>
+<p><strong>SORT COLUMN BOUNDS:</strong> 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>
+<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>
+<p><strong>NOTE:</strong></p>
+<ul>
+<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>Users can find more information about this option in the description of PR1953.</li>
+</ul>
+</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>
+</li>
+</ul>
+<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><strong>NOTE:</strong></p>
+<ul>
+<li>If this option is set to TRUE then data loading will take less time.</li>
+<li>If this option is set to some invalid value other than TRUE or FALSE then it uses the default value.</li>
+</ul>
+<p>Example:</p>
+<pre><code>LOAD DATA local inpath '/opt/rawdata/data.csv' INTO table carbontable
+options('DELIMITER'=',', 'QUOTECHAR'='"','COMMENTCHAR'='#',
+'HEADER'='false',
+'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>Load all of the data before dealing with the errors.</li>
+<li>Clean or delete bad records before loading data or stop the loading when bad records are found.</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>
+</li>
+</ul>
+<p><strong>NOTE:</strong></p>
+<ul>
+<li>BAD_RECORDS_ACTION property can have four type of actions for bad records FORCE, REDIRECT, IGNORE and FAIL.</li>
+<li>FAIL option is its Default value. If the FAIL option is used, then data loading fails if any bad records are found.</li>
+<li>If the REDIRECT option is used, CarbonData 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.</li>
+<li>If the FORCE option is used, then it auto-converts the data by storing the bad records as NULL before Loading data.</li>
+<li>If the IGNORE option is used, then bad records are neither loaded nor written to the separate CSV file.</li>
+<li>In loaded data, if all records are bad records, the BAD_RECORDS_ACTION is invalid and the load operation fails.</li>
+<li>The default maximum number of characters per column is 32000. If there are more than 32000 characters in a column, please refer to <em>String longer than 32000 characters</em> section.</li>
+<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></p>
+<p>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',
+'BAD_RECORDS_ACTION'='REDIRECT','IS_EMPTY_DATA_BAD_RECORD'='false')
+</code></pre>
+<ul>
+<li>
+<strong>GLOBAL_SORT_PARTITIONS:</strong> If the SORT_SCOPE is defined as GLOBAL_SORT, then user can specify the number of partitions to use while shuffling data for sort using GLOBAL_SORT_PARTITIONS. If it is not configured, or configured less than 1, then it uses the number of map task as reduce task. It is recommended that each reduce task deal with 512MB-1GB data.</li>
+</ul>
+<pre><code>OPTIONS('GLOBAL_SORT_PARTITIONS'='2')
+</code></pre>
+<p>NOTE:</p>
+<ul>
+<li>GLOBAL_SORT_PARTITIONS should be Integer type, the range is [1,Integer.MaxValue].</li>
+<li>It is only used when the SORT_SCOPE is GLOBAL_SORT.</li>
+</ul>
+<h3>
+<a id="insert-data-into-carbondata-table" class="anchor" href="#insert-data-into-carbondata-table" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>INSERT DATA INTO CARBONDATA TABLE</h3>
+<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>
+<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>
+<p>Overwrite insert data:</p>
+<pre><code>INSERT OVERWRITE TABLE <CARBONDATA TABLE> SELECT * FROM sourceTableName
+[ WHERE { <filter_condition> } ]
+</code></pre>
+<p><strong>NOTE:</strong></p>
+<ul>
+<li>The source table and the CarbonData table must have the same table schema.</li>
+<li>The data type of source and destination table columns should be same</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>Examples</p>
+<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 OVERWRITE TABLE table1 SELECT * FROM TABLE2
+</code></pre>
+<h2>
+<a id="update-and-delete" class="anchor" href="#update-and-delete" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>UPDATE AND DELETE</h2>
+<h3>
+<a id="update" class="anchor" href="#update" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>UPDATE</h3>
+<p>This command will allow to update the CarbonData table based on the column expression and optional filter conditions.</p>
+<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 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>
+<p><strong>NOTE:</strong> The update command fails if multiple input rows in source table are matched with single row in destination table.</p>
+<p>Examples:</p>
+<pre><code>UPDATE t3 SET (t3_salary) = (t3_salary + 9) WHERE t3_name = 'aaa1'
+</code></pre>
+<pre><code>UPDATE t3 SET (t3_date, t3_country) = ('2017-11-18', 'india') WHERE t3_salary < 15003
+</code></pre>
+<pre><code>UPDATE t3 SET (t3_country, t3_name) = (SELECT t5_country, t5_name FROM t5 WHERE t5_id = 5) WHERE t3_id < 5
+</code></pre>
+<pre><code>UPDATE t3 SET (t3_date, t3_serialname, t3_salary) = (SELECT '2099-09-09', t5_serialname, '9999' FROM t5 WHERE t5_id = 5) WHERE t3_id < 5
+</code></pre>
+<pre><code>UPDATE t3 SET (t3_country, t3_salary) = (SELECT t5_country, t5_salary FROM t5 FULL JOIN t3 u WHERE u.t3_id = t5_id and t5_id=6) WHERE t3_id >6
+</code></pre>
+<p>NOTE: Update Complex datatype columns is not supported.</p>
+<h3>
+<a id="delete" class="anchor" href="#delete" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>DELETE</h3>
+<p>This command allows us to delete records from CarbonData table.</p>
+<pre><code>DELETE FROM table_name [WHERE expression]
+</code></pre>
+<p>Examples:</p>
+<pre><code>DELETE FROM carbontable WHERE column1 = 'china'
+</code></pre>
+<pre><code>DELETE FROM carbontable WHERE column1 IN ('china', 'USA')
+</code></pre>
+<pre><code>DELETE FROM carbontable WHERE column1 IN (SELECT column11 FROM sourceTable2)
+</code></pre>
+<pre><code>DELETE FROM carbontable WHERE column1 IN (SELECT column11 FROM sourceTable2 WHERE column1 = 'USA')
+</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>Compaction improves the query performance significantly.</p>
+<p>There are several types of compaction.</p>
+<pre><code>ALTER TABLE [db_name.]table_name COMPACT 'MINOR/MAJOR/CUSTOM'
+</code></pre>
+<ul>
+<li><strong>Minor Compaction</strong></li>
+</ul>
+<p>In Minor compaction, user can specify the number of loads to be merged.
+Minor compaction triggers for every data load if the parameter carbon.enable.auto.load.merge is set to true.
+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 larger segment.</li>
+</ul>
+<pre><code>ALTER TABLE table_name COMPACT 'MINOR'
+</code></pre>
+<ul>
+<li><strong>Major Compaction</strong></li>
+</ul>
+<p>In Major compaction, multiple segments can be merged into one large segment.
+User will specify the compaction size until which segments can be merged, Major compaction is usually done during the off-peak time.
+Configure the property carbon.major.compaction.size with appropriate value in MB.</p>
+<p>This command merges the specified number of segments into one segment:</p>
+<pre><code>ALTER TABLE table_name COMPACT 'MAJOR'
+</code></pre>
+<ul>
+<li><strong>Custom Compaction</strong></li>
+</ul>
+<p>In Custom compaction, user can directly specify segment ids to be merged into one large segment.
+All specified segment ids should exist and be valid, otherwise compaction will fail.
+Custom compaction is usually done during the off-peak time.</p>
+<pre><code>ALTER TABLE table_name COMPACT 'CUSTOM' WHERE SEGMENT.ID IN (2,3,4)
+</code></pre>
+<p>NOTE: Compaction is unsupported for table containing Complex columns.</p>
+<ul>
+<li><strong>CLEAN SEGMENTS AFTER Compaction</strong></li>
+</ul>
+<p>Clean the segments which are compacted:</p>
+<pre><code>CLEAN FILES FOR TABLE carbon_table
+</code></pre>
+<h2>
+<a id="partition" class="anchor" href="#partition" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>PARTITION</h2>
+<h3>
+<a id="standard-partition" class="anchor" href="#standard-partition" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>STANDARD PARTITION</h3>
+<p>The partition is similar as spark and hive partition, user can use any column to build partition:</p>
+<h4>
+<a id="create-partition-table" class="anchor" href="#create-partition-table" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Create Partition Table</h4>
+<p>This command allows you to create table with partition.</p>
+<pre><code>CREATE TABLE [IF NOT EXISTS] [db_name.]table_name
+ [(col_name data_type , ...)]
+ [COMMENT table_comment]
+ [PARTITIONED BY (col_name data_type , ...)]
+ [STORED BY file_format]
+ [TBLPROPERTIES (property_name=property_value, ...)]
+</code></pre>
+<p>Example:</p>
+<pre><code> CREATE TABLE IF NOT EXISTS productSchema.productSalesTable (
+ productNumber INT,
+ productName STRING,
+ storeCity STRING,
+ storeProvince STRING,
+ saleQuantity INT,
+ revenue INT)
+PARTITIONED BY (productCategory STRING, productBatch STRING)
+STORED BY 'carbondata'
+</code></pre>
+<p>NOTE: Hive partition is not supported on complex datatype columns.</p>
+<h4>
+<a id="load-data-using-static-partition" class="anchor" href="#load-data-using-static-partition" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Load Data Using Static Partition</h4>
+<p>This command allows you to load data using static partition.</p>
+<pre><code>LOAD DATA [LOCAL] INPATH 'folder_path'
+INTO TABLE [db_name.]table_name PARTITION (partition_spec)
+OPTIONS(property_name=property_value, ...)
+INSERT INTO INTO TABLE [db_name.]table_name PARTITION (partition_spec) <SELECT STATEMENT>
+</code></pre>
+<p>Example:</p>
+<pre><code>LOAD DATA LOCAL INPATH '${env:HOME}/staticinput.csv'
+INTO TABLE locationTable
+PARTITION (country = 'US', state = 'CA')
+INSERT INTO TABLE locationTable
+PARTITION (country = 'US', state = 'AL')
+SELECT <columns list excluding partition columns> FROM another_user
+</code></pre>
+<h4>
+<a id="load-data-using-dynamic-partition" class="anchor" href="#load-data-using-dynamic-partition" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Load Data Using Dynamic Partition</h4>
+<p>This command allows you to load data using dynamic partition. If partition spec is not specified, then the partition is considered as dynamic.</p>
+<p>Example:</p>
+<pre><code>LOAD DATA LOCAL INPATH '${env:HOME}/staticinput.csv'
+INTO TABLE locationTable
+INSERT INTO TABLE locationTable
+SELECT <columns list excluding partition columns> FROM another_user
+</code></pre>
+<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>
+<pre><code>SHOW PARTITIONS [db_name.]table_name
+</code></pre>
+<h4>
+<a id="drop-partition" class="anchor" href="#drop-partition" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Drop Partition</h4>
+<p>This command drops the specified Hive partition only.</p>
+<pre><code>ALTER TABLE table_name DROP [IF EXISTS] PARTITION (part_spec, ...)
+</code></pre>
+<p>Example:</p>
+<pre><code>ALTER TABLE locationTable DROP PARTITION (country = 'US');
+</code></pre>
+<h4>
+<a id="insert-overwrite" class="anchor" href="#insert-overwrite" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Insert OVERWRITE</h4>
+<p>This command allows you to insert or load overwrite on a specific partition.</p>
+<pre><code> INSERT OVERWRITE TABLE table_name
+ PARTITION (column = 'partition_name')
+ select_statement
+</code></pre>
+<p>Example:</p>
+<pre><code>INSERT OVERWRITE TABLE partitioned_user
+PARTITION (country = 'US')
+SELECT * FROM another_user au
+WHERE au.country = 'US';
+</code></pre>
+<h3>
+<a id="carbondata-partitionhashrangelist----alpha-feature-this-partition-feature-does-not-support-update-and-delete-data" class="anchor" href="#carbondata-partitionhashrangelist----alpha-feature-this-partition-feature-does-not-support-update-and-delete-data" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>CARBONDATA PARTITION(HASH,RANGE,LIST) -- Alpha feature, this partition feature does not support update and delete data.</h3>
+<p>The partition supports three type:(Hash,Range,List), similar to other system's partition features, CarbonData's partition feature can be used to improve query performance by filtering on the partition column.</p>
+<h3>
+<a id="create-hash-partition-table" class="anchor" href="#create-hash-partition-table" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Create Hash Partition Table</h3>
+<p>This command allows us to create hash partition.</p>
+<pre><code>CREATE TABLE [IF NOT EXISTS] [db_name.]table_name
+ [(col_name data_type , ...)]
+PARTITIONED BY (partition_col_name data_type)
+STORED BY 'carbondata'
+[TBLPROPERTIES ('PARTITION_TYPE'='HASH',
+ 'NUM_PARTITIONS'='N' ...)]
+</code></pre>
+<p><strong>NOTE:</strong> N is the number of hash partitions</p>
+<p>Example:</p>
+<pre><code>CREATE TABLE IF NOT EXISTS hash_partition_table(
+ col_A STRING,
+ col_B INT,
+ col_C LONG,
+ col_D DECIMAL(10,2),
+ col_F TIMESTAMP
+) PARTITIONED BY (col_E LONG)
+STORED BY 'carbondata' TBLPROPERTIES('PARTITION_TYPE'='HASH','NUM_PARTITIONS'='9')
+</code></pre>
+<h3>
+<a id="create-range-partition-table" class="anchor" href="#create-range-partition-table" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Create Range Partition Table</h3>
+<p>This command allows us to create range partition.</p>
+<pre><code>CREATE TABLE [IF NOT EXISTS] [db_name.]table_name
+ [(col_name data_type , ...)]
+PARTITIONED BY (partition_col_name data_type)
+STORED BY 'carbondata'
+[TBLPROPERTIES ('PARTITION_TYPE'='RANGE',
+ 'RANGE_INFO'='2014-01-01, 2015-01-01, 2016-01-01, ...')]
+</code></pre>
+<p><strong>NOTE:</strong></p>
+<ul>
+<li>The 'RANGE_INFO' must be defined in ascending order in the table properties.</li>
+<li>The default format for partition column of Date/Timestamp type is yyyy-MM-dd. Alternate formats for Date/Timestamp could be defined in CarbonProperties.</li>
+</ul>
+<p>Example:</p>
+<pre><code>CREATE TABLE IF NOT EXISTS range_partition_table(
+ col_A STRING,
+ col_B INT,
+ col_C LONG,
+ col_D DECIMAL(10,2),
+ col_E LONG
+ ) partitioned by (col_F Timestamp)
+ PARTITIONED BY 'carbondata'
+ TBLPROPERTIES('PARTITION_TYPE'='RANGE',
+ 'RANGE_INFO'='2015-01-01, 2016-01-01, 2017-01-01, 2017-02-01')
+</code></pre>
+<h3>
+<a id="create-list-partition-table" class="anchor" href="#create-list-partition-table" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Create List Partition Table</h3>
+<p>This command allows us to create list partition.</p>
+<pre><code>CREATE TABLE [IF NOT EXISTS] [db_name.]table_name
+ [(col_name data_type , ...)]
+PARTITIONED BY (partition_col_name data_type)
+STORED BY 'carbondata'
+[TBLPROPERTIES ('PARTITION_TYPE'='LIST',
+ 'LIST_INFO'='A, B, C, ...')]
+</code></pre>
+<p><strong>NOTE:</strong> List partition supports list info in one level group.</p>
+<p>Example:</p>
+<pre><code>CREATE TABLE IF NOT EXISTS list_partition_table(
+ col_B INT,
+ col_C LONG,
+ col_D DECIMAL(10,2),
+ col_E LONG,
+ col_F TIMESTAMP
+ ) PARTITIONED BY (col_A STRING)
+ STORED BY 'carbondata'
+ TBLPROPERTIES('PARTITION_TYPE'='LIST',
+ 'LIST_INFO'='aaaa, bbbb, (cccc, dddd), eeee')
+</code></pre>
+<h3>
+<a id="show-partitions-1" class="anchor" href="#show-partitions-1" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Show Partitions</h3>
+<p>The following command is executed to get the partition information of the table</p>
+<pre><code>SHOW PARTITIONS [db_name.]table_name
+</code></pre>
+<h3>
+<a id="add-a-new-partition" class="anchor" href="#add-a-new-partition" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Add a new partition</h3>
+<pre><code>ALTER TABLE [db_name].table_name ADD PARTITION('new_partition')
+</code></pre>
+<h3>
+<a id="split-a-partition" class="anchor" href="#split-a-partition" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Split a partition</h3>
+<pre><code>ALTER TABLE [db_name].table_name SPLIT PARTITION(partition_id) INTO('new_partition1', 'new_partition2'...)
+</code></pre>
+<h3>
+<a id="drop-a-partition" class="anchor" href="#drop-a-partition" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Drop a partition</h3>
+<p>Only drop partition definition, but keep data</p>
+<pre><code> ALTER TABLE [db_name].table_name DROP PARTITION(partition_id)
+</code></pre>
+<p>Drop both partition definition and data</p>
+<pre><code>ALTER TABLE [db_name].table_name DROP PARTITION(partition_id) WITH DATA
+</code></pre>
+<p><strong>NOTE:</strong></p>
+<ul>
+<li>Hash partition table is not supported for ADD, SPLIT and DROP commands.</li>
+<li>Partition Id: in CarbonData like the hive, folders are not used to divide partitions instead partition id is used to replace the task id. It could make use of the characteristic and meanwhile reduce some metadata.</li>
+</ul>
+<pre><code>SegmentDir/0_batchno0-0-1502703086921.carbonindex
+ ^
+SegmentDir/part-0-0_batchno0-0-1502703086921.carbondata
+ ^
+</code></pre>
+<p>Here are some useful tips to improve query performance of carbonData partition table:</p>
+<ul>
+<li>The partitioned column can be excluded from SORT_COLUMNS, this will let other columns to do the efficient sorting.</li>
+<li>When writing SQL on a partition table, try to use filters on the partition column.</li>
+</ul>
+<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, 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>
+<p><strong>NOTE:</strong></p>
+<ul>
+<li>Bucketing cannot be performed for columns of Complex Data Types.</li>
+<li>Columns in the BUCKETCOLUMN parameter must be dimensions. The BUCKETCOLUMN parameter cannot be a measure or a combination of measures and dimensions.</li>
+</ul>
+<p>Example:</p>
+<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 ('BUCKETNUMBER'='4', 'BUCKETCOLUMNS'='productName')
+</code></pre>
+<h2>
+<a id="segment-management" class="anchor" href="#segment-management" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>SEGMENT MANAGEMENT</h2>
+<h3>
+<a id="show-segment" class="anchor" href="#show-segment" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>SHOW SEGMENT</h3>
+<p>This command is used to list the segments of CarbonData table.</p>
+<pre><code>SHOW [HISTORY] SEGMENTS FOR TABLE [db_name.]table_name LIMIT number_of_segments
+</code></pre>
+<p>Example:
+Show visible segments</p>
+<pre><code>SHOW SEGMENTS FOR TABLE CarbonDatabase.CarbonTable LIMIT 4
+</code></pre>
+<p>Show all segments, include invisible segments</p>
+<pre><code>SHOW HISTORY SEGMENTS FOR TABLE CarbonDatabase.CarbonTable LIMIT 4
+</code></pre>
+<h3>
+<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</h3>
+<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>
+<p>Example:</p>
+<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>
+<h3>
+<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</h3>
+<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>
+<p>Example:</p>
+<pre><code>DELETE FROM TABLE CarbonDatabase.CarbonTable WHERE SEGMENT.STARTTIME BEFORE '2017-06-01 12:05:06'
+</code></pre>
+<h3>
+<a id="query-data-with-specified-segments" class="anchor" href="#query-data-with-specified-segments" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>QUERY DATA WITH SPECIFIED SEGMENTS</h3>
+<p>This command is used to read data from specified segments during CarbonScan.</p>
+<p>Get the Segment ID:</p>
+<pre><code>SHOW SEGMENTS FOR TABLE [db_name.]table_name LIMIT number_of_segments
+</code></pre>
+<p>Set the segment IDs for table</p>
+<pre><code>SET carbon.input.segments.<database_name>.<table_name> = <list of segment IDs>
+</code></pre>
+<p><strong>NOTE:</strong>
+carbon.input.segments: Specifies the segment IDs to be queried. This property allows you to query specified segments of the specified table. The CarbonScan will read data from specified segments only.</p>
+<p>If user wants to query with segments reading in multi threading mode, then CarbonSession. threadSet can be used instead of SET query.</p>
+<pre><code>CarbonSession.threadSet ("carbon.input.segments.<database_name>.<table_name>","<list of segment IDs>");
+</code></pre>
+<p>Reset the segment IDs</p>
+<pre><code>SET carbon.input.segments.<database_name>.<table_name> = *;
+</code></pre>
+<p>If user wants to query with segments reading in multi threading mode, then CarbonSession. threadSet can be used instead of SET query.</p>
+<pre><code>CarbonSession.threadSet ("carbon.input.segments.<database_name>.<table_name>","*");
+</code></pre>
+<p><strong>Examples:</strong></p>
+<ul>
+<li>Example to show the list of segment IDs,segment status, and other required details and then specify the list of segments to be read.</li>
+</ul>
+<pre><code>SHOW SEGMENTS FOR carbontable1;
+
+SET carbon.input.segments.db.carbontable1 = 1,3,9;
+</code></pre>
+<ul>
+<li>Example to query with segments reading in multi threading mode:</li>
+</ul>
+<pre><code>CarbonSession.threadSet ("carbon.input.segments.db.carbontable_Multi_Thread","1,3");
+</code></pre>
+<ul>
+<li>Example for threadset in multithread environment (following shows how it is used in Scala code):</li>
+</ul>
+<pre><code>def main(args: Array[String]) {
+Future {
+ CarbonSession.threadSet ("carbon.input.segments.db.carbontable_Multi_Thread","1")
+ spark.sql("select count(empno) from carbon.input.segments.db.carbontable_Multi_Thread").show();
+ }
+ }
+</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
[19/20] carbondata-site git commit: Updated changes for 1.5.0 release
Posted by ch...@apache.org.
http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6f8949f1/content/data-management.html
----------------------------------------------------------------------
diff --git a/content/data-management.html b/content/data-management.html
new file mode 100644
index 0000000..93528d8
--- /dev/null
+++ b/content/data-management.html
@@ -0,0 +1,413 @@
+<!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/6f8949f1/content/ddl-operation-on-carbondata.html
----------------------------------------------------------------------
diff --git a/content/ddl-operation-on-carbondata.html b/content/ddl-operation-on-carbondata.html
new file mode 100644
index 0000000..444428f
--- /dev/null
+++ b/content/ddl-operation-on-carbondata.html
@@ -0,0 +1,748 @@
+<!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/6f8949f1/content/dml-operation-on-carbondata.html
----------------------------------------------------------------------
diff --git a/content/dml-operation-on-carbondata.html b/content/dml-operation-on-carbondata.html
new file mode 100644
index 0000000..b6a5642
--- /dev/null
+++ b/content/dml-operation-on-carbondata.html
@@ -0,0 +1,716 @@
+<!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
[15/20] carbondata-site git commit: modified for 1.5.0 version
Posted by ch...@apache.org.
modified for 1.5.0 version
Project: http://git-wip-us.apache.org/repos/asf/carbondata-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/carbondata-site/commit/6ad7599a
Tree: http://git-wip-us.apache.org/repos/asf/carbondata-site/tree/6ad7599a
Diff: http://git-wip-us.apache.org/repos/asf/carbondata-site/diff/6ad7599a
Branch: refs/heads/asf-site
Commit: 6ad7599a8cc7f9a577247a563e9a24038c0de7fc
Parents: bee5633
Author: Raghunandan S <ca...@gmail.com>
Authored: Tue Oct 9 10:03:04 2018 +0530
Committer: Raghunandan S <ca...@gmail.com>
Committed: Wed Oct 17 06:35:21 2018 +0530
----------------------------------------------------------------------
content/CSDK-guide.html | 422 ++++++
content/WEB-INF/classes/application.conf | 4 +-
content/bloomfilter-datamap-guide.html | 16 +-
content/carbon-as-spark-datasource-guide.html | 349 +++++
content/configuration-parameters.html | 187 +--
content/css/style.css | 5 +
content/data-management-on-carbondata.html | 1321 ------------------
content/data-management.html | 413 ------
content/datamap-developer-guide.html | 14 +-
content/datamap-management.html | 18 +-
content/ddl-of-carbondata.html | 210 ++-
content/ddl-operation-on-carbondata.html | 748 ----------
content/dml-of-carbondata.html | 26 +-
content/dml-operation-on-carbondata.html | 716 ----------
content/documentation.html | 12 +-
content/faq.html | 31 +-
content/file-structure-of-carbondata.html | 12 +-
.../how-to-contribute-to-apache-carbondata.html | 14 +-
content/index.html | 12 +-
content/installation-guide.html | 455 ------
content/introduction.html | 30 +-
content/language-manual.html | 13 +-
content/lucene-datamap-guide.html | 14 +-
content/mainpage.html | 214 ---
content/performance-tuning.html | 20 +-
content/preaggregate-datamap-guide.html | 12 +-
content/quick-start-guide.html | 45 +-
content/release-guide.html | 10 +-
content/s3-guide.html | 12 +-
content/sdk-guide.html | 323 +++--
content/sdk-writer-guide.html | 549 --------
content/security.html | 2 +-
content/segment-management-on-carbondata.html | 10 +-
content/streaming-guide.html | 49 +-
content/supported-data-types-in-carbondata.html | 15 +-
content/timeseries-datamap-guide.html | 10 +-
content/troubleshooting.html | 366 -----
content/usecases.html | 42 +-
content/useful-tips-on-carbondata.html | 480 -------
src/main/resources/application.conf | 4 +-
src/main/scala/MdFileHandler.scala | 2 +-
src/main/scala/html/header.html | 10 +-
src/main/scala/scripts/CSDK-guide | 11 +
.../scripts/carbon-as-spark-datasource-guide | 11 +
src/main/scala/scripts/sdk-guide | 11 +-
src/main/webapp/CSDK-guide.html | 422 ++++++
src/main/webapp/bloomfilter-datamap-guide.html | 16 +-
.../carbon-as-spark-datasource-guide.html | 349 +++++
src/main/webapp/configuration-parameters.html | 187 +--
src/main/webapp/css/style.css | 5 +
src/main/webapp/datamap-developer-guide.html | 14 +-
src/main/webapp/datamap-management.html | 18 +-
src/main/webapp/ddl-of-carbondata.html | 210 ++-
src/main/webapp/dml-of-carbondata.html | 26 +-
src/main/webapp/documentation.html | 12 +-
src/main/webapp/faq.html | 31 +-
.../webapp/file-structure-of-carbondata.html | 12 +-
.../how-to-contribute-to-apache-carbondata.html | 14 +-
src/main/webapp/introduction.html | 30 +-
src/main/webapp/language-manual.html | 13 +-
src/main/webapp/lucene-datamap-guide.html | 14 +-
src/main/webapp/performance-tuning.html | 20 +-
src/main/webapp/preaggregate-datamap-guide.html | 12 +-
src/main/webapp/quick-start-guide.html | 45 +-
src/main/webapp/release-guide.html | 10 +-
src/main/webapp/s3-guide.html | 12 +-
src/main/webapp/sdk-guide.html | 323 +++--
.../segment-management-on-carbondata.html | 10 +-
src/main/webapp/streaming-guide.html | 49 +-
.../supported-data-types-in-carbondata.html | 15 +-
src/main/webapp/timeseries-datamap-guide.html | 10 +-
src/main/webapp/usecases.html | 42 +-
src/site/markdown/CSDK-guide.md | 197 +++
src/site/markdown/bloomfilter-datamap-guide.md | 6 +-
.../carbon-as-spark-datasource-guide.md | 99 ++
src/site/markdown/configuration-parameters.md | 163 +--
src/site/markdown/datamap-developer-guide.md | 4 +-
src/site/markdown/datamap-management.md | 8 +-
src/site/markdown/ddl-of-carbondata.md | 167 ++-
src/site/markdown/dml-of-carbondata.md | 20 +-
src/site/markdown/documentation.md | 2 +-
src/site/markdown/faq.md | 22 +-
.../markdown/file-structure-of-carbondata.md | 2 +-
.../how-to-contribute-to-apache-carbondata.md | 4 +-
src/site/markdown/introduction.md | 20 +-
src/site/markdown/language-manual.md | 4 +-
src/site/markdown/lucene-datamap-guide.md | 4 +-
src/site/markdown/performance-tuning.md | 10 +-
src/site/markdown/preaggregate-datamap-guide.md | 2 +-
src/site/markdown/quick-start-guide.md | 35 +-
src/site/markdown/s3-guide.md | 2 +-
src/site/markdown/sdk-guide.md | 281 ++--
src/site/markdown/streaming-guide.md | 39 +-
.../supported-data-types-in-carbondata.md | 5 +
src/site/markdown/usecases.md | 32 +-
95 files changed, 3809 insertions(+), 6490 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6ad7599a/content/CSDK-guide.html
----------------------------------------------------------------------
diff --git a/content/CSDK-guide.html b/content/CSDK-guide.html
new file mode 100644
index 0000000..193d74f
--- /dev/null
+++ b/content/CSDK-guide.html
@@ -0,0 +1,422 @@
+<!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>
+ <script defer src="https://use.fontawesome.com/releases/v5.0.8/js/all.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.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>
+ <a href="https://dist.apache.org/repos/dist/release/carbondata/1.4.0/"
+ target="_blank">Apache CarbonData 1.4.0</a></li>
+ <li>
+ <a href="https://dist.apache.org/repos/dist/release/carbondata/1.3.1/"
+ target="_blank">Apache CarbonData 1.3.1</a></li>
+ <li>
+ <a href="https://dist.apache.org/repos/dist/release/carbondata/1.3.0/"
+ target="_blank">Apache CarbonData 1.3.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="documentation.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="verticalnavbar">
+ <nav class="b-sticky-nav">
+ <div class="nav-scroller">
+ <div class="nav__inner">
+ <a class="b-nav__intro nav__item" href="./introduction.html">introduction</a>
+ <a class="b-nav__quickstart nav__item" href="./quick-start-guide.html">quick start</a>
+ <a class="b-nav__uses nav__item" href="./usecases.html">use cases</a>
+
+ <div class="nav__item nav__item__with__subs">
+ <a class="b-nav__docs nav__item nav__sub__anchor" href="./language-manual.html">Language Reference</a>
+ <a class="nav__item nav__sub__item" href="./ddl-of-carbondata.html">DDL</a>
+ <a class="nav__item nav__sub__item" href="./dml-of-carbondata.html">DML</a>
+ <a class="nav__item nav__sub__item" href="./streaming-guide.html">Streaming</a>
+ <a class="nav__item nav__sub__item" href="./configuration-parameters.html">Configuration</a>
+ <a class="nav__item nav__sub__item" href="./datamap-developer-guide.html">Datamaps</a>
+ <a class="nav__item nav__sub__item" href="./supported-data-types-in-carbondata.html">Data Types</a>
+ </div>
+
+ <div class="nav__item nav__item__with__subs">
+ <a class="b-nav__datamap nav__item nav__sub__anchor" href="./datamap-management.html">DataMaps</a>
+ <a class="nav__item nav__sub__item" href="./bloomfilter-datamap-guide.html">Bloom Filter</a>
+ <a class="nav__item nav__sub__item" href="./lucene-datamap-guide.html">Lucene</a>
+ <a class="nav__item nav__sub__item" href="./preaggregate-datamap-guide.html">Pre-Aggregate</a>
+ <a class="nav__item nav__sub__item" href="./timeseries-datamap-guide.html">Time Series</a>
+ </div>
+
+ <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>
+ <a class="b-nav__contri nav__item" href="./how-to-contribute-to-apache-carbondata.html">Contribute</a>
+ <a class="b-nav__security nav__item" href="./security.html">Security</a>
+ <a class="b-nav__release nav__item" href="./release-guide.html">Release Guide</a>
+ </div>
+ </div>
+ <div class="navindicator">
+ <div class="b-nav__intro navindicator__item"></div>
+ <div class="b-nav__quickstart navindicator__item"></div>
+ <div class="b-nav__uses navindicator__item"></div>
+ <div class="b-nav__docs navindicator__item"></div>
+ <div class="b-nav__datamap navindicator__item"></div>
+ <div class="b-nav__api navindicator__item"></div>
+ <div class="b-nav__perf navindicator__item"></div>
+ <div class="b-nav__s3 navindicator__item"></div>
+ <div class="b-nav__faq navindicator__item"></div>
+ <div class="b-nav__contri navindicator__item"></div>
+ <div class="b-nav__security navindicator__item"></div>
+ </div>
+ </nav>
+ </div>
+ <div class="mdcontent">
+ <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="csdk-guide" class="anchor" href="#csdk-guide" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>CSDK Guide</h1>
+<p>CarbonData CSDK provides C++ interface to write and read carbon file.
+CSDK use JNI to invoke java SDK in C++ code.</p>
+<h1>
+<a id="csdk-reader" class="anchor" href="#csdk-reader" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>CSDK Reader</h1>
+<p>This CSDK reader reads CarbonData file and carbonindex file at a given path.
+External client can make use of this reader to read CarbonData files in C++
+code and without CarbonSession.</p>
+<p>In the carbon jars package, there exist a carbondata-sdk.jar,
+including SDK reader for CSDK.</p>
+<h2>
+<a id="quick-example" class="anchor" href="#quick-example" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Quick example</h2>
+<pre><code>// 1. init JVM
+JavaVM *jvm;
+JNIEnv *initJVM() {
+ JNIEnv *env;
+ JavaVMInitArgs vm_args;
+ int parNum = 3;
+ int res;
+ JavaVMOption options[parNum];
+
+ options[0].optionString = "-Djava.compiler=NONE";
+ options[1].optionString = "-Djava.class.path=../../sdk/target/carbondata-sdk.jar";
+ options[2].optionString = "-verbose:jni";
+ vm_args.version = JNI_VERSION_1_8;
+ vm_args.nOptions = parNum;
+ vm_args.options = options;
+ vm_args.ignoreUnrecognized = JNI_FALSE;
+
+ res = JNI_CreateJavaVM(&jvm, (void **) &env, &vm_args);
+ if (res < 0) {
+ fprintf(stderr, "\nCan't create Java VM\n");
+ exit(1);
+ }
+
+ return env;
+}
+
+// 2. create carbon reader and read data
+// 2.1 read data from local disk
+/**
+ * test read data from local disk, without projection
+ *
+ * @param env jni env
+ * @return
+ */
+bool readFromLocalWithoutProjection(JNIEnv *env) {
+
+ CarbonReader carbonReaderClass;
+ carbonReaderClass.builder(env, "../resources/carbondata", "test");
+ carbonReaderClass.build();
+
+ while (carbonReaderClass.hasNext()) {
+ jobjectArray row = carbonReaderClass.readNextRow();
+ jsize length = env->GetArrayLength(row);
+ int j = 0;
+ for (j = 0; j < length; j++) {
+ jobject element = env->GetObjectArrayElement(row, j);
+ char *str = (char *) env->GetStringUTFChars((jstring) element, JNI_FALSE);
+ printf("%s\t", str);
+ }
+ printf("\n");
+ }
+ carbonReaderClass.close();
+}
+
+// 2.2 read data from S3
+
+/**
+ * read data from S3
+ * parameter is ak sk endpoint
+ *
+ * @param env jni env
+ * @param argv argument vector
+ * @return
+ */
+bool readFromS3(JNIEnv *env, char *argv[]) {
+ CarbonReader reader;
+
+ char *args[3];
+ // "your access key"
+ args[0] = argv[1];
+ // "your secret key"
+ args[1] = argv[2];
+ // "your endPoint"
+ args[2] = argv[3];
+
+ reader.builder(env, "s3a://sdk/WriterOutput", "test");
+ reader.withHadoopConf(3, args);
+ reader.build();
+ printf("\nRead data from S3:\n");
+ while (reader.hasNext()) {
+ jobjectArray row = reader.readNextRow();
+ jsize length = env->GetArrayLength(row);
+
+ int j = 0;
+ for (j = 0; j < length; j++) {
+ jobject element = env->GetObjectArrayElement(row, j);
+ char *str = (char *) env->GetStringUTFChars((jstring) element, JNI_FALSE);
+ printf("%s\t", str);
+ }
+ printf("\n");
+ }
+
+ reader.close();
+}
+
+// 3. destory JVM
+ (jvm)->DestroyJavaVM();
+</code></pre>
+<p>Find example code at main.cpp of CSDK module</p>
+<h2>
+<a id="api-list" class="anchor" href="#api-list" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>API List</h2>
+<pre><code> /**
+ * create a CarbonReaderBuilder object for building carbonReader,
+ * CarbonReaderBuilder object can configure different parameter
+ *
+ * @param env JNIEnv
+ * @param path data store path
+ * @param tableName table name
+ * @return CarbonReaderBuilder object
+ */
+ jobject builder(JNIEnv *env, char *path, char *tableName);
+
+ /**
+ * Configure the projection column names of carbon reader
+ *
+ * @param argc argument counter
+ * @param argv argument vector
+ * @return CarbonReaderBuilder object
+ */
+ jobject projection(int argc, char *argv[]);
+
+ /**
+ * build carbon reader with argument vector
+ * it support multiple parameter
+ * like: key=value
+ * for example: fs.s3a.access.key=XXXX, XXXX is user's access key value
+ *
+ * @param argc argument counter
+ * @param argv argument vector
+ * @return CarbonReaderBuilder object
+ **/
+ jobject withHadoopConf(int argc, char *argv[]);
+
+ /**
+ * build carbonReader object for reading data
+ * it support read data from load disk
+ *
+ * @return carbonReader object
+ */
+ jobject build();
+
+ /**
+ * Whether it has next row data
+ *
+ * @return boolean value, if it has next row, return true. if it hasn't next row, return false.
+ */
+ jboolean hasNext();
+
+ /**
+ * read next row from data
+ *
+ * @return object array of one row
+ */
+ jobjectArray readNextRow();
+
+ /**
+ * close the carbon reader
+ *
+ * @return boolean value
+ */
+ jboolean close();
+
+</code></pre>
+<script>
+$(function() {
+ // Show selected style on nav item
+ $('.b-nav__api').addClass('selected');
+
+ if (!$('.b-nav__api').parent().hasClass('nav__item__with__subs--expanded')) {
+ // Display api subnav items
+ $('.b-nav__api').parent().toggleClass('nav__item__with__subs--expanded');
+ }
+});
+</script></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/WEB-INF/classes/application.conf
----------------------------------------------------------------------
diff --git a/content/WEB-INF/classes/application.conf b/content/WEB-INF/classes/application.conf
index ba425e5..020b127 100644
--- a/content/WEB-INF/classes/application.conf
+++ b/content/WEB-INF/classes/application.conf
@@ -16,7 +16,9 @@ fileList=["configuration-parameters",
"release-guide",
"how-to-contribute-to-apache-carbondata",
"introduction",
- "usecases"
+ "usecases",
+ "CSDK-guide",
+ "carbon-as-spark-datasource-guide"
]
dataMapFileList=[
"bloomfilter-datamap-guide",
http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6ad7599a/content/bloomfilter-datamap-guide.html
----------------------------------------------------------------------
diff --git a/content/bloomfilter-datamap-guide.html b/content/bloomfilter-datamap-guide.html
index 8030599..2ecfa44 100644
--- a/content/bloomfilter-datamap-guide.html
+++ b/content/bloomfilter-datamap-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>
@@ -211,7 +219,7 @@
<div class="col-sm-12 col-md-12">
<div>
<h1>
-<a id="carbondata-bloomfilter-datamap-alpha-feature" class="anchor" href="#carbondata-bloomfilter-datamap-alpha-feature" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>CarbonData BloomFilter DataMap (Alpha Feature)</h1>
+<a id="carbondata-bloomfilter-datamap" class="anchor" href="#carbondata-bloomfilter-datamap" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>CarbonData BloomFilter DataMap</h1>
<ul>
<li><a href="#datamap-management">DataMap Management</a></li>
<li><a href="#bloomfilter-datamap-introduction">BloomFilter Datamap Introduction</a></li>
@@ -238,7 +246,7 @@ ON TABLE main_table
</code></pre>
<p>Disable Datamap</p>
<blockquote>
-<p>The datamap by default is enabled. To support tuning on query, we can disable a specific datamap during query to observe whether we can gain performance enhancement from it. This will only take effect current session.</p>
+<p>The datamap by default is enabled. To support tuning on query, we can disable a specific datamap during query to observe whether we can gain performance enhancement from it. This is effective only for current session.</p>
</blockquote>
<pre><code>// disable the datamap
SET carbon.datamap.visible.dbName.tableName.dataMapName = false
@@ -268,7 +276,7 @@ and we always query on <code>id</code> and <code>name</code> with precise value.
since <code>id</code> is in the sort_columns and it is orderd,
query on it will be fast because CarbonData can skip all the irrelative blocklets.
But queries on <code>name</code> may be bad since the blocklet minmax may not help,
-because in each blocklet the range of the value of <code>name</code> may be the same -- all from A<em>~z</em>.
+because in each blocklet the range of the value of <code>name</code> may be the same -- all from A* to z*.
In this case, user can create a BloomFilter datamap on column <code>name</code>.
Moreover, user can also create a BloomFilter datamap on the sort_columns.
This is useful if user has too many segments and the range of the value of sort_columns are almost the same.</p>
http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6ad7599a/content/carbon-as-spark-datasource-guide.html
----------------------------------------------------------------------
diff --git a/content/carbon-as-spark-datasource-guide.html b/content/carbon-as-spark-datasource-guide.html
new file mode 100644
index 0000000..e29f120
--- /dev/null
+++ b/content/carbon-as-spark-datasource-guide.html
@@ -0,0 +1,349 @@
+<!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>
+ <script defer src="https://use.fontawesome.com/releases/v5.0.8/js/all.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.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>
+ <a href="https://dist.apache.org/repos/dist/release/carbondata/1.4.0/"
+ target="_blank">Apache CarbonData 1.4.0</a></li>
+ <li>
+ <a href="https://dist.apache.org/repos/dist/release/carbondata/1.3.1/"
+ target="_blank">Apache CarbonData 1.3.1</a></li>
+ <li>
+ <a href="https://dist.apache.org/repos/dist/release/carbondata/1.3.0/"
+ target="_blank">Apache CarbonData 1.3.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="documentation.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="verticalnavbar">
+ <nav class="b-sticky-nav">
+ <div class="nav-scroller">
+ <div class="nav__inner">
+ <a class="b-nav__intro nav__item" href="./introduction.html">introduction</a>
+ <a class="b-nav__quickstart nav__item" href="./quick-start-guide.html">quick start</a>
+ <a class="b-nav__uses nav__item" href="./usecases.html">use cases</a>
+
+ <div class="nav__item nav__item__with__subs">
+ <a class="b-nav__docs nav__item nav__sub__anchor" href="./language-manual.html">Language Reference</a>
+ <a class="nav__item nav__sub__item" href="./ddl-of-carbondata.html">DDL</a>
+ <a class="nav__item nav__sub__item" href="./dml-of-carbondata.html">DML</a>
+ <a class="nav__item nav__sub__item" href="./streaming-guide.html">Streaming</a>
+ <a class="nav__item nav__sub__item" href="./configuration-parameters.html">Configuration</a>
+ <a class="nav__item nav__sub__item" href="./datamap-developer-guide.html">Datamaps</a>
+ <a class="nav__item nav__sub__item" href="./supported-data-types-in-carbondata.html">Data Types</a>
+ </div>
+
+ <div class="nav__item nav__item__with__subs">
+ <a class="b-nav__datamap nav__item nav__sub__anchor" href="./datamap-management.html">DataMaps</a>
+ <a class="nav__item nav__sub__item" href="./bloomfilter-datamap-guide.html">Bloom Filter</a>
+ <a class="nav__item nav__sub__item" href="./lucene-datamap-guide.html">Lucene</a>
+ <a class="nav__item nav__sub__item" href="./preaggregate-datamap-guide.html">Pre-Aggregate</a>
+ <a class="nav__item nav__sub__item" href="./timeseries-datamap-guide.html">Time Series</a>
+ </div>
+
+ <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>
+ <a class="b-nav__contri nav__item" href="./how-to-contribute-to-apache-carbondata.html">Contribute</a>
+ <a class="b-nav__security nav__item" href="./security.html">Security</a>
+ <a class="b-nav__release nav__item" href="./release-guide.html">Release Guide</a>
+ </div>
+ </div>
+ <div class="navindicator">
+ <div class="b-nav__intro navindicator__item"></div>
+ <div class="b-nav__quickstart navindicator__item"></div>
+ <div class="b-nav__uses navindicator__item"></div>
+ <div class="b-nav__docs navindicator__item"></div>
+ <div class="b-nav__datamap navindicator__item"></div>
+ <div class="b-nav__api navindicator__item"></div>
+ <div class="b-nav__perf navindicator__item"></div>
+ <div class="b-nav__s3 navindicator__item"></div>
+ <div class="b-nav__faq navindicator__item"></div>
+ <div class="b-nav__contri navindicator__item"></div>
+ <div class="b-nav__security navindicator__item"></div>
+ </div>
+ </nav>
+ </div>
+ <div class="mdcontent">
+ <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="carbondata-as-sparks-datasource" class="anchor" href="#carbondata-as-sparks-datasource" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>CarbonData as Spark's Datasource</h1>
+<p>The CarbonData fileformat is now integrated as Spark datasource for read and write operation without using CarbonSession. This is useful for users who wants to use carbondata as spark's data source.</p>
+<p><strong>Note:</strong> You can only apply the functions/features supported by spark datasource APIs, functionalities supported would be similar to Parquet. The carbon session features are not supported.</p>
+<h1>
+<a id="create-table-with-ddl" class="anchor" href="#create-table-with-ddl" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Create Table with DDL</h1>
+<p>Now you can create Carbon table using Spark's datasource DDL syntax.</p>
+<pre><code> CREATE [TEMPORARY] TABLE [IF NOT EXISTS] [db_name.]table_name
+ [(col_name1 col_type1 [COMMENT col_comment1], ...)]
+ USING CARBON
+ [OPTIONS (key1=val1, key2=val2, ...)]
+ [PARTITIONED BY (col_name1, col_name2, ...)]
+ [CLUSTERED BY (col_name3, col_name4, ...) INTO num_buckets BUCKETS]
+ [LOCATION path]
+ [COMMENT table_comment]
+ [TBLPROPERTIES (key1=val1, key2=val2, ...)]
+ [AS select_statement]
+</code></pre>
+<h2>
+<a id="supported-options" class="anchor" href="#supported-options" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Supported OPTIONS</h2>
+<table>
+<thead>
+<tr>
+<th>Property</th>
+<th>Default Value</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>table_blocksize</td>
+<td>1024</td>
+<td>Size of blocks to write onto hdfs. For more details, see <a href="./ddl-of-carbondata.html#table-block-size-configuration">Table Block Size Configuration</a>.</td>
+</tr>
+<tr>
+<td>table_blocklet_size</td>
+<td>64</td>
+<td>Size of blocklet to write.</td>
+</tr>
+<tr>
+<td>local_dictionary_threshold</td>
+<td>10000</td>
+<td>Cardinality upto which the local dictionary can be generated. For more details, see <a href="./ddl-of-carbondata.html#local-dictionary-configuration">Local Dictionary Configuration</a>.</td>
+</tr>
+<tr>
+<td>local_dictionary_enable</td>
+<td>false</td>
+<td>Enable local dictionary generation. For more details, see <a href="./ddl-of-carbondata.html#local-dictionary-configuration">Local Dictionary Configuration</a>.</td>
+</tr>
+<tr>
+<td>sort_columns</td>
+<td>all dimensions are sorted</td>
+<td>Columns to include in sort and its order of sort. For more details, see <a href="./ddl-of-carbondata.html#sort-columns-configuration">Sort Columns Configuration</a>.</td>
+</tr>
+<tr>
+<td>sort_scope</td>
+<td>local_sort</td>
+<td>Sort scope of the load.Options include no sort, local sort, batch sort, and global sort. For more details, see <a href="./ddl-of-carbondata.html#sort-scope-configuration">Sort Scope Configuration</a>.</td>
+</tr>
+<tr>
+<td>long_string_columns</td>
+<td>null</td>
+<td>Comma separated string/char/varchar columns which are more than 32k length. For more details, see <a href="./ddl-of-carbondata.html#string-longer-than-32000-characters">String longer than 32000 characters</a>.</td>
+</tr>
+</tbody>
+</table>
+<h2>
+<a id="example" class="anchor" href="#example" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Example</h2>
+<pre><code> CREATE TABLE CARBON_TABLE (NAME STRING) USING CARBON OPTIONS('table_block_size'='256')
+</code></pre>
+<h1>
+<a id="using-dataframe" class="anchor" href="#using-dataframe" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Using DataFrame</h1>
+<p>Carbon format can be used in dataframe also. Following are the ways to use carbon format in dataframe.</p>
+<p>Write carbon using dataframe</p>
+<pre><code>df.write.format("carbon").save(path)
+</code></pre>
+<p>Read carbon using dataframe</p>
+<pre><code>val df = spark.read.format("carbon").load(path)
+</code></pre>
+<h2>
+<a id="example-1" class="anchor" href="#example-1" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Example</h2>
+<pre><code>import org.apache.spark.sql.SparkSession
+
+val spark = SparkSession
+ .builder()
+ .appName("Spark SQL basic example")
+ .config("spark.some.config.option", "some-value")
+ .getOrCreate()
+
+// For implicit conversions like converting RDDs to DataFrames
+import spark.implicits._
+val df = spark.sparkContext.parallelize(1 to 10 * 10 * 1000)
+ .map(x => (r.nextInt(100000), "name" + x % 8, "city" + x % 50, BigDecimal.apply(x % 60)))
+ .toDF("ID", "name", "city", "age")
+
+// Write to carbon format
+df.write.format("carbon").save("/user/person_table")
+
+// Read carbon using dataframe
+val dfread = spark.read.format("carbon").load("/user/person_table")
+dfread.show()
+</code></pre>
+<p>Reference : <a href="./configuration-parameters.html">list of carbon properties</a></p>
+<script>
+$(function() {
+ // Show selected style on nav item
+ $('.b-nav__docs').addClass('selected');
+
+ // Display docs subnav items
+ if (!$('.b-nav__docs').parent().hasClass('nav__item__with__subs--expanded')) {
+ $('.b-nav__docs').parent().toggleClass('nav__item__with__subs--expanded');
+ }
+});
+</script></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
[16/20] carbondata-site git commit: Updated changes for 1.5.0 release
Posted by ch...@apache.org.
Updated changes for 1.5.0 release
Project: http://git-wip-us.apache.org/repos/asf/carbondata-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/carbondata-site/commit/07526d0e
Tree: http://git-wip-us.apache.org/repos/asf/carbondata-site/tree/07526d0e
Diff: http://git-wip-us.apache.org/repos/asf/carbondata-site/diff/07526d0e
Branch: refs/heads/asf-site
Commit: 07526d0efa471b02e9868570f350bdba00db36bd
Parents: bee5633 6ad7599
Author: chenliang613 <ch...@huawei.com>
Authored: Wed Oct 17 18:13:41 2018 +0800
Committer: chenliang613 <ch...@huawei.com>
Committed: Wed Oct 17 18:13:41 2018 +0800
----------------------------------------------------------------------
content/CSDK-guide.html | 422 ++++++
content/WEB-INF/classes/application.conf | 4 +-
content/bloomfilter-datamap-guide.html | 16 +-
content/carbon-as-spark-datasource-guide.html | 349 +++++
content/configuration-parameters.html | 187 +--
content/css/style.css | 5 +
content/data-management-on-carbondata.html | 1321 ------------------
content/data-management.html | 413 ------
content/datamap-developer-guide.html | 14 +-
content/datamap-management.html | 18 +-
content/ddl-of-carbondata.html | 210 ++-
content/ddl-operation-on-carbondata.html | 748 ----------
content/dml-of-carbondata.html | 26 +-
content/dml-operation-on-carbondata.html | 716 ----------
content/documentation.html | 12 +-
content/faq.html | 31 +-
content/file-structure-of-carbondata.html | 12 +-
.../how-to-contribute-to-apache-carbondata.html | 14 +-
content/index.html | 12 +-
content/installation-guide.html | 455 ------
content/introduction.html | 30 +-
content/language-manual.html | 13 +-
content/lucene-datamap-guide.html | 14 +-
content/mainpage.html | 214 ---
content/performance-tuning.html | 20 +-
content/preaggregate-datamap-guide.html | 12 +-
content/quick-start-guide.html | 45 +-
content/release-guide.html | 10 +-
content/s3-guide.html | 12 +-
content/sdk-guide.html | 323 +++--
content/sdk-writer-guide.html | 549 --------
content/security.html | 2 +-
content/segment-management-on-carbondata.html | 10 +-
content/streaming-guide.html | 49 +-
content/supported-data-types-in-carbondata.html | 15 +-
content/timeseries-datamap-guide.html | 10 +-
content/troubleshooting.html | 366 -----
content/usecases.html | 42 +-
content/useful-tips-on-carbondata.html | 480 -------
src/main/resources/application.conf | 4 +-
src/main/scala/MdFileHandler.scala | 2 +-
src/main/scala/html/header.html | 10 +-
src/main/scala/scripts/CSDK-guide | 11 +
.../scripts/carbon-as-spark-datasource-guide | 11 +
src/main/scala/scripts/sdk-guide | 11 +-
src/main/webapp/CSDK-guide.html | 422 ++++++
src/main/webapp/bloomfilter-datamap-guide.html | 16 +-
.../carbon-as-spark-datasource-guide.html | 349 +++++
src/main/webapp/configuration-parameters.html | 187 +--
src/main/webapp/css/style.css | 5 +
src/main/webapp/datamap-developer-guide.html | 14 +-
src/main/webapp/datamap-management.html | 18 +-
src/main/webapp/ddl-of-carbondata.html | 210 ++-
src/main/webapp/dml-of-carbondata.html | 26 +-
src/main/webapp/documentation.html | 12 +-
src/main/webapp/faq.html | 31 +-
.../webapp/file-structure-of-carbondata.html | 12 +-
.../how-to-contribute-to-apache-carbondata.html | 14 +-
src/main/webapp/introduction.html | 30 +-
src/main/webapp/language-manual.html | 13 +-
src/main/webapp/lucene-datamap-guide.html | 14 +-
src/main/webapp/performance-tuning.html | 20 +-
src/main/webapp/preaggregate-datamap-guide.html | 12 +-
src/main/webapp/quick-start-guide.html | 45 +-
src/main/webapp/release-guide.html | 10 +-
src/main/webapp/s3-guide.html | 12 +-
src/main/webapp/sdk-guide.html | 323 +++--
.../segment-management-on-carbondata.html | 10 +-
src/main/webapp/streaming-guide.html | 49 +-
.../supported-data-types-in-carbondata.html | 15 +-
src/main/webapp/timeseries-datamap-guide.html | 10 +-
src/main/webapp/usecases.html | 42 +-
src/site/markdown/CSDK-guide.md | 197 +++
src/site/markdown/bloomfilter-datamap-guide.md | 6 +-
.../carbon-as-spark-datasource-guide.md | 99 ++
src/site/markdown/configuration-parameters.md | 163 +--
src/site/markdown/datamap-developer-guide.md | 4 +-
src/site/markdown/datamap-management.md | 8 +-
src/site/markdown/ddl-of-carbondata.md | 167 ++-
src/site/markdown/dml-of-carbondata.md | 20 +-
src/site/markdown/documentation.md | 2 +-
src/site/markdown/faq.md | 22 +-
.../markdown/file-structure-of-carbondata.md | 2 +-
.../how-to-contribute-to-apache-carbondata.md | 4 +-
src/site/markdown/introduction.md | 20 +-
src/site/markdown/language-manual.md | 4 +-
src/site/markdown/lucene-datamap-guide.md | 4 +-
src/site/markdown/performance-tuning.md | 10 +-
src/site/markdown/preaggregate-datamap-guide.md | 2 +-
src/site/markdown/quick-start-guide.md | 35 +-
src/site/markdown/s3-guide.md | 2 +-
src/site/markdown/sdk-guide.md | 281 ++--
src/site/markdown/streaming-guide.md | 39 +-
.../supported-data-types-in-carbondata.md | 5 +
src/site/markdown/usecases.md | 32 +-
95 files changed, 3809 insertions(+), 6490 deletions(-)
----------------------------------------------------------------------
[03/20] carbondata-site git commit: modified for 1.5.0 version
Posted by ch...@apache.org.
http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6ad7599a/src/site/markdown/configuration-parameters.md
----------------------------------------------------------------------
diff --git a/src/site/markdown/configuration-parameters.md b/src/site/markdown/configuration-parameters.md
index c8c74f2..0a4565a 100644
--- a/src/site/markdown/configuration-parameters.md
+++ b/src/site/markdown/configuration-parameters.md
@@ -7,7 +7,7 @@
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
-
+
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -16,7 +16,7 @@
-->
# Configuring CarbonData
- This guide explains the configurations that can be used to tune CarbonData to achieve better performance.Most of the properties that control the internal settings have reasonable default values.They are listed along with the properties along with explanation.
+ This guide explains the configurations that can be used to tune CarbonData to achieve better performance.Most of the properties that control the internal settings have reasonable default values. They are listed along with the properties along with explanation.
* [System Configuration](#system-configuration)
* [Data Loading Configuration](#data-loading-configuration)
@@ -31,119 +31,122 @@ This section provides the details of all the configurations required for the Car
| Property | Default Value | Description |
|----------------------------|-------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| carbon.storelocation | spark.sql.warehouse.dir property value | Location where CarbonData will create the store, and write the data in its custom format. If not specified,the path defaults to spark.sql.warehouse.dir property. NOTE: Store location should be in HDFS. |
-| carbon.ddl.base.hdfs.url | (none) | To simplify and shorten the path to be specified in DDL/DML commands, this property is supported.This property is used to configure the HDFS relative path, the path configured in carbon.ddl.base.hdfs.url will be appended to the HDFS path configured in fs.defaultFS of core-site.xml. If this path is configured, then user need not pass the complete path while dataload. For example: If absolute path of the csv file is hdfs://10.18.101.155:54310/data/cnbc/2016/xyz.csv, the path "hdfs://10.18.101.155:54310" will come from property fs.defaultFS and user can configure the /data/cnbc/ as carbon.ddl.base.hdfs.url. Now while dataload user can specify the csv path as /2016/xyz.csv. |
-| carbon.badRecords.location | (none) | CarbonData can detect the records not conforming to defined table schema and isolate them as bad records.This property is used to specify where to store such bad records. |
-| carbon.streaming.auto.handoff.enabled | true | CarbonData supports storing of streaming data.To have high throughput for streaming, the data is written in Row format which is highly optimized for write, but performs poorly for query.When this property is true and when the streaming data size reaches ***carbon.streaming.segment.max.size***, CabonData will automatically convert the data to columnar format and optimize it for faster querying.**NOTE:** It is not recommended to keep the default value which is true. |
-| carbon.streaming.segment.max.size | 1024000000 | CarbonData writes streaming data in row format which is optimized for high write throughput.This property defines the maximum size of data to be held is row format, beyond which it will be converted to columnar format in order to support high performane query, provided ***carbon.streaming.auto.handoff.enabled*** is true. **NOTE:** Setting higher value will impact the streaming ingestion. The value has to be configured in bytes. |
-| carbon.query.show.datamaps | true | CarbonData stores datamaps as independent tables so as to allow independent maintenance to some extent.When this property is true,which is by default, show tables command will list all the tables including datatmaps(eg: Preaggregate table), else datamaps will be excluded from the table list.**NOTE:** It is generally not required for the user to do any maintenance operations on these tables and hence not required to be seen.But it is shown by default so that user or admin can get clear understanding of the system for capacity planning. |
-| carbon.segment.lock.files.preserve.hours | 48 | In order to support parallel data loading onto the same table, CarbonData sequences(locks) at the granularity of segments.Operations affecting the segment(like IUD, alter) are blocked from parallel operations.This property value indicates the number of hours the segment lock files will be preserved after dataload. These lock files will be deleted with the clean command after the configured number of hours. |
-| carbon.timestamp.format | yyyy-MM-dd HH:mm:ss | CarbonData can understand data of timestamp type and process it in special manner.It can be so that the format of Timestamp data is different from that understood by CarbonData by default.This configuration allows users to specify the format of Timestamp in their data. |
+| carbon.storelocation | spark.sql.warehouse.dir property value | Location where CarbonData will create the store, and write the data in its custom format. If not specified,the path defaults to spark.sql.warehouse.dir property. **NOTE:** Store location should be in HDFS. |
+| carbon.ddl.base.hdfs.url | (none) | To simplify and shorten the path to be specified in DDL/DML commands, this property is supported. This property is used to configure the HDFS relative path, the path configured in carbon.ddl.base.hdfs.url will be appended to the HDFS path configured in fs.defaultFS of core-site.xml. If this path is configured, then user need not pass the complete path while dataload. For example: If absolute path of the csv file is hdfs://10.18.101.155:54310/data/cnbc/2016/xyz.csv, the path "hdfs://10.18.101.155:54310" will come from property fs.defaultFS and user can configure the /data/cnbc/ as carbon.ddl.base.hdfs.url. Now while dataload user can specify the csv path as /2016/xyz.csv. |
+| carbon.badRecords.location | (none) | CarbonData can detect the records not conforming to defined table schema and isolate them as bad records. This property is used to specify where to store such bad records. |
+| carbon.streaming.auto.handoff.enabled | true | CarbonData supports storing of streaming data. To have high throughput for streaming, the data is written in Row format which is highly optimized for write, but performs poorly for query. When this property is true and when the streaming data size reaches ***carbon.streaming.segment.max.size***, CabonData will automatically convert the data to columnar format and optimize it for faster querying.**NOTE:** It is not recommended to keep the default value which is true. |
+| carbon.streaming.segment.max.size | 1024000000 | CarbonData writes streaming data in row format which is optimized for high write throughput. This property defines the maximum size of data to be held is row format, beyond which it will be converted to columnar format in order to support high performance query, provided ***carbon.streaming.auto.handoff.enabled*** is true. **NOTE:** Setting higher value will impact the streaming ingestion. The value has to be configured in bytes. |
+| carbon.query.show.datamaps | true | CarbonData stores datamaps as independent tables so as to allow independent maintenance to some extent. When this property is true,which is by default, show tables command will list all the tables including datatmaps(eg: Preaggregate table), else datamaps will be excluded from the table list.**NOTE:** It is generally not required for the user to do any maintenance operations on these tables and hence not required to be seen.But it is shown by default so that user or admin can get clear understanding of the system for capacity planning. |
+| carbon.segment.lock.files.preserve.hours | 48 | In order to support parallel data loading onto the same table, CarbonData sequences(locks) at the granularity of segments.Operations affecting the segment(like IUD, alter) are blocked from parallel operations. This property value indicates the number of hours the segment lock files will be preserved after dataload. These lock files will be deleted with the clean command after the configured number of hours. |
+| carbon.timestamp.format | yyyy-MM-dd HH:mm:ss | CarbonData can understand data of timestamp type and process it in special manner.It can be so that the format of Timestamp data is different from that understood by CarbonData by default. This configuration allows users to specify the format of Timestamp in their data. |
| carbon.lock.type | LOCALLOCK | This configuration specifies the type of lock to be acquired during concurrent operations on table. There are following types of lock implementation: - LOCALLOCK: Lock is created on local file system as file. This lock is useful when only one spark driver (thrift server) runs on a machine and no other CarbonData spark application is launched concurrently. - HDFSLOCK: Lock is created on HDFS file system as file. This lock is useful when multiple CarbonData spark applications are launched and no ZooKeeper is running on cluster and HDFS supports file based locking. |
| carbon.lock.path | TABLEPATH | This configuration specifies the path where lock files have to be created. Recommended to configure zookeeper lock type or configure HDFS lock path(to this property) in case of S3 file system as locking is not feasible on S3. |
-| carbon.unsafe.working.memory.in.mb | 512 | CarbonData supports storing data in off-heap memory for certain operations during data loading and query.This helps to avoid the Java GC and thereby improve the overall performance.The Minimum value recommeded is 512MB.Any value below this is reset to default value of 512MB.**NOTE:** The below formulas explain how to arrive at the off-heap size required.<u>Memory Required For Data Loading:</u>(*carbon.number.of.cores.while.loading*) * (Number of tables to load in parallel) * (*offheap.sort.chunk.size.inmb* + *carbon.blockletgroup.size.in.mb* + *carbon.blockletgroup.size.in.mb*/3.5 ). <u>Memory required for Query:</u>SPARK_EXECUTOR_INSTANCES * (*carbon.blockletgroup.size.in.mb* + *carbon.blockletgroup.size.in.mb* * 3.5) * spark.executor.cores |
-| carbon.update.sync.folder | /tmp/carbondata | CarbonData maintains last modification time entries in modifiedTime.mdt to determine the schema changes and reload only when necessary.This configuration specifies the path where the file needs to be written. |
-| carbon.invisible.segments.preserve.count | 200 | CarbonData maintains each data load entry in tablestatus file. The entries from this file are not deleted for those segments that are compacted or dropped, but are made invisible.If the number of data loads are very high, the size and number of entries in tablestatus file can become too many causing unnecessary reading of all data.This configuration specifies the number of segment entries to be maintained afte they are compacted or dropped.Beyond this, the entries are moved to a separate history tablestatus file.**NOTE:** The entries in tablestatus file help to identify the operations performed on CarbonData table and is also used for checkpointing during various data manupulation operations.This is similar to AUDIT file maintaining all the operations and its status.Hence the entries are never deleted but moved to a separate history file. |
-| carbon.lock.retries | 3 | CarbonData ensures consistency of operations by blocking certain operations from running in parallel.In order to block the operations from running in parallel, lock is obtained on the table.This configuration specifies the maximum number of retries to obtain the lock for any operations other than load.**NOTE:** Data manupulation operations like Compaction,UPDATE,DELETE or LOADING,UPDATE,DELETE are not allowed to run in parallel.How ever data loading can happen in parallel to compaction. |
-| carbon.lock.retry.timeout.sec | 5 | Specifies the interval between the retries to obtain the lock for any operation other than load.**NOTE:** Refer to ***carbon.lock.retries*** for understanding why CarbonData uses locks for operations. |
+| carbon.unsafe.working.memory.in.mb | 512 | CarbonData supports storing data in off-heap memory for certain operations during data loading and query. This helps to avoid the Java GC and thereby improve the overall performance. The Minimum value recommeded is 512MB. Any value below this is reset to default value of 512MB. **NOTE:** The below formulas explain how to arrive at the off-heap size required.<u>Memory Required For Data Loading:</u>(*carbon.number.of.cores.while.loading*) * (Number of tables to load in parallel) * (*offheap.sort.chunk.size.inmb* + *carbon.blockletgroup.size.in.mb* + *carbon.blockletgroup.size.in.mb*/3.5 ). <u>Memory required for Query:</u>SPARK_EXECUTOR_INSTANCES * (*carbon.blockletgroup.size.in.mb* + *carbon.blockletgroup.size.in.mb* * 3.5) * spark.executor.cores |
+| carbon.unsafe.driver.working.memory.in.mb | 60% of JVM Heap Memory | CarbonData supports storing data in unsafe on-heap memory in driver for certain operations like insert into, query for loading datamap cache. The Minimum value recommended is 512MB. |
+| carbon.update.sync.folder | /tmp/carbondata | CarbonData maintains last modification time entries in modifiedTime.mdt to determine the schema changes and reload only when necessary. This configuration specifies the path where the file needs to be written. |
+| carbon.invisible.segments.preserve.count | 200 | CarbonData maintains each data load entry in tablestatus file. The entries from this file are not deleted for those segments that are compacted or dropped, but are made invisible. If the number of data loads are very high, the size and number of entries in tablestatus file can become too many causing unnecessary reading of all data. This configuration specifies the number of segment entries to be maintained afte they are compacted or dropped.Beyond this, the entries are moved to a separate history tablestatus file. **NOTE:** The entries in tablestatus file help to identify the operations performed on CarbonData table and is also used for checkpointing during various data manupulation operations. This is similar to AUDIT file maintaining all the operations and its status.Hence the entries are never deleted but moved to a separate history file. |
+| carbon.lock.retries | 3 | CarbonData ensures consistency of operations by blocking certain operations from running in parallel. In order to block the operations from running in parallel, lock is obtained on the table. This configuration specifies the maximum number of retries to obtain the lock for any operations other than load. **NOTE:** Data manupulation operations like Compaction,UPDATE,DELETE or LOADING,UPDATE,DELETE are not allowed to run in parallel.How ever data loading can happen in parallel to compaction. |
+| carbon.lock.retry.timeout.sec | 5 | Specifies the interval between the retries to obtain the lock for any operation other than load. **NOTE:** Refer to ***carbon.lock.retries*** for understanding why CarbonData uses locks for operations. |
## Data Loading Configuration
| Parameter | Default Value | Description |
|--------------------------------------|---------------|----------------------------------------------------------------------------------------------------------------------|
-| carbon.number.of.cores.while.loading | 2 | Number of cores to be used while loading data.This also determines the number of threads to be used to read the input files (csv) in parallel.**NOTE:** This configured value is used in every data loading step to parallelize the operations. Configuring a higher value can lead to increased early thread pre-emption by OS and there by reduce the overall performance. |
+| carbon.number.of.cores.while.loading | 2 | Number of cores to be used while loading data. This also determines the number of threads to be used to read the input files (csv) in parallel.**NOTE:** This configured value is used in every data loading step to parallelize the operations. Configuring a higher value can lead to increased early thread pre-emption by OS and there by reduce the overall performance. |
| carbon.sort.size | 100000 | Number of records to hold in memory to sort and write intermediate temp files.**NOTE:** Memory required for data loading increases with increase in configured value as each thread would cache configured number of records. |
| carbon.global.sort.rdd.storage.level | MEMORY_ONLY | Storage level to persist dataset of RDD/dataframe when loading data with 'sort_scope'='global_sort', if user's executor has less memory, set this parameter to 'MEMORY_AND_DISK_SER' or other storage level to correspond to different environment. [See detail](http://spark.apache.org/docs/latest/rdd-programming-guide.html#rdd-persistence). |
| carbon.load.global.sort.partitions | 0 | The Number of partitions to use when shuffling data for sort. Default value 0 means to use same number of map tasks as reduce tasks.**NOTE:** In general, it is recommended to have 2-3 tasks per CPU core in your cluster. |
-| carbon.options.bad.records.logger.enable | false | CarbonData can identify the records that are not conformant to schema and isolate them as bad records.Enabling this configuration will make CarbonData to log such bad records.**NOTE:** If the input data contains many bad records, logging them will slow down the over all data loading throughput.The data load operation status would depend on the configuration in ***carbon.bad.records.action***. |
-| carbon.bad.records.action | FAIL | CarbonData in addition to identifying the bad records, can take certain actions on such data.This configuration can have four types of actions for bad records namely FORCE, REDIRECT, IGNORE and FAIL. If set to FORCE then it auto-corrects the data by storing the bad records as NULL. If set to REDIRECT then bad records are written to the raw CSV instead of being loaded. If set to IGNORE then bad records are neither loaded nor written to the raw CSV. If set to FAIL then data loading fails if any bad records are found. |
+| carbon.options.bad.records.logger.enable | false | CarbonData can identify the records that are not conformant to schema and isolate them as bad records. Enabling this configuration will make CarbonData to log such bad records.**NOTE:** If the input data contains many bad records, logging them will slow down the over all data loading throughput. The data load operation status would depend on the configuration in ***carbon.bad.records.action***. |
+| carbon.bad.records.action | FAIL | CarbonData in addition to identifying the bad records, can take certain actions on such data. This configuration can have four types of actions for bad records namely FORCE, REDIRECT, IGNORE and FAIL. If set to FORCE then it auto-corrects the data by storing the bad records as NULL. If set to REDIRECT then bad records are written to the raw CSV instead of being loaded. If set to IGNORE then bad records are neither loaded nor written to the raw CSV. If set to FAIL then data loading fails if any bad records are found. |
| carbon.options.is.empty.data.bad.record | false | Based on the business scenarios, empty("" or '' or ,,) data can be valid or invalid. This configuration controls how empty data should be treated by CarbonData. If false, then empty ("" or '' or ,,) data will not be considered as bad record and vice versa. |
| carbon.options.bad.record.path | (none) | Specifies the HDFS path where bad records are to be stored. By default the value is Null. This path must to be configured by the user if ***carbon.options.bad.records.logger.enable*** is **true** or ***carbon.bad.records.action*** is **REDIRECT**. |
-| carbon.blockletgroup.size.in.mb | 64 | Please refer to [file-structure-of-carbondata](./file-structure-of-carbondata.md#carbondata-file-format) to understand the storage format of CarbonData.The data are read as a group of blocklets which are called blocklet groups. This parameter specifies the size of each blocklet group. Higher value results in better sequential IO access.The minimum value is 16MB, any value lesser than 16MB will reset to the default value (64MB).**NOTE:** Configuring a higher value might lead to poor performance as an entire blocklet group will have to read into memory before processing.For filter queries with limit, it is **not advisable** to have a bigger blocklet size.For Aggregation queries which need to return more number of rows,bigger blocklet size is advisable. |
-| carbon.sort.file.write.buffer.size | 16384 | CarbonData sorts and writes data to intermediate files to limit the memory usage.This configuration determines the buffer size to be used for reading and writing such files. **NOTE:** This configuration is useful to tune IO and derive optimal performance.Based on the OS and underlying harddisk type, these values can significantly affect the overall performance.It is ideal to tune the buffersize equivalent to the IO buffer size of the OS.Recommended range is between 10240 to 10485760 bytes. |
-| carbon.sort.intermediate.files.limit | 20 | CarbonData sorts and writes data to intermediate files to limit the memory usage.Before writing the target carbondat file, the data in these intermediate files needs to be sorted again so as to ensure the entire data in the data load is sorted.This configuration determines the minimum number of intermediate files after which merged sort is applied on them sort the data.**NOTE:** Intermediate merging happens on a separate thread in the background.Number of threads used is determined by ***carbon.merge.sort.reader.thread***.Configuring a low value will cause more time to be spent in merging these intermediate merged files which can cause more IO.Configuring a high value would cause not to use the idle threads to do intermediate sort merges.Range of recommended values are between 2 and 50 |
-| carbon.csv.read.buffersize.byte | 1048576 | CarbonData uses Hadoop InputFormat to read the csv files.This configuration value is used to pass buffer size as input for the Hadoop MR job when reading the csv files.This value is configured in bytes.**NOTE:** Refer to ***org.apache.hadoop.mapreduce.InputFormat*** documentation for additional information. |
-| carbon.merge.sort.reader.thread | 3 | CarbonData sorts and writes data to intermediate files to limit the memory usage.When the intermediate files reaches ***carbon.sort.intermediate.files.limit*** the files will be merged,the number of threads specified in this configuration will be used to read the intermediate files for performing merge sort.**NOTE:** Refer to ***carbon.sort.intermediate.files.limit*** for operation description.Configuring less number of threads can cause merging to slow down over loading process where as configuring more number of threads can cause thread contention with threads in other data loading steps.Hence configure a fraction of ***carbon.number.of.cores.while.loading***. |
-| carbon.concurrent.lock.retries | 100 | CarbonData supports concurrent data loading onto same table.To ensure the loading status is correctly updated into the system,locks are used to sequence the status updation step.This configuration specifies the maximum number of retries to obtain the lock for updating the load status.**NOTE:** This value is high as more number of concurrent loading happens,more the chances of not able to obtain the lock when tried.Adjust this value according to the number of concurrent loading to be supported by the system. |
-| carbon.concurrent.lock.retry.timeout.sec | 1 | Specifies the interval between the retries to obtain the lock for concurrent operations.**NOTE:** Refer to ***carbon.concurrent.lock.retries*** for understanding why CarbonData uses locks during data loading operations. |
-| carbon.skip.empty.line | false | The csv files givent to CarbonData for loading can contain empty lines.Based on the business scenario, this empty line might have to be ignored or needs to be treated as NULL value for all columns.In order to define this business behavior, this configuration is provided.**NOTE:** In order to consider NULL values for non string columns and continue with data load, ***carbon.bad.records.action*** need to be set to **FORCE**;else data load will be failed as bad records encountered. |
-| carbon.enable.calculate.size | true | **For Load Operation**: Setting this property calculates the size of the carbon data file (.carbondata) and carbon index file (.carbonindex) for every load and updates the table status file. **For Describe Formatted**: Setting this property calculates the total size of the carbon data files and carbon index files for the respective table and displays in describe formatted command.**NOTE:** This is useful to determine the overall size of the carbondata table and also get an idea of how the table is growing in order to take up other backup strategy decisions. |
+| carbon.blockletgroup.size.in.mb | 64 | Please refer to [file-structure-of-carbondata](./file-structure-of-carbondata.md#carbondata-file-format) to understand the storage format of CarbonData. The data are read as a group of blocklets which are called blocklet groups. This parameter specifies the size of each blocklet group. Higher value results in better sequential IO access. The minimum value is 16MB, any value lesser than 16MB will reset to the default value (64MB).**NOTE:** Configuring a higher value might lead to poor performance as an entire blocklet group will have to read into memory before processing.For filter queries with limit, it is **not advisable** to have a bigger blocklet size. For Aggregation queries which need to return more number of rows,bigger blocklet size is advisable. |
+| carbon.sort.file.write.buffer.size | 16384 | CarbonData sorts and writes data to intermediate files to limit the memory usage. This configuration determines the buffer size to be used for reading and writing such files. **NOTE:** This configuration is useful to tune IO and derive optimal performance.Based on the OS and underlying harddisk type, these values can significantly affect the overall performance.It is ideal to tune the buffersize equivalent to the IO buffer size of the OS.Recommended range is between 10240 to 10485760 bytes. |
+| carbon.sort.intermediate.files.limit | 20 | CarbonData sorts and writes data to intermediate files to limit the memory usage. Before writing the target carbondat file, the data in these intermediate files needs to be sorted again so as to ensure the entire data in the data load is sorted. This configuration determines the minimum number of intermediate files after which merged sort is applied on them sort the data.**NOTE:** Intermediate merging happens on a separate thread in the background.Number of threads used is determined by ***carbon.merge.sort.reader.thread***.Configuring a low value will cause more time to be spent in merging these intermediate merged files which can cause more IO.Configuring a high value would cause not to use the idle threads to do intermediate sort merges.Range of recommended values are between 2 and 50 |
+| carbon.csv.read.buffersize.byte | 1048576 | CarbonData uses Hadoop InputFormat to read the csv files. This configuration value is used to pass buffer size as input for the Hadoop MR job when reading the csv files. This value is configured in bytes.**NOTE:** Refer to ***org.apache.hadoop.mapreduce.InputFormat*** documentation for additional information. |
+| carbon.merge.sort.reader.thread | 3 | CarbonData sorts and writes data to intermediate files to limit the memory usage. When the intermediate files reaches ***carbon.sort.intermediate.files.limit*** the files will be merged,the number of threads specified in this configuration will be used to read the intermediate files for performing merge sort.**NOTE:** Refer to ***carbon.sort.intermediate.files.limit*** for operation description.Configuring less number of threads can cause merging to slow down over loading process where as configuring more number of threads can cause thread contention with threads in other data loading steps.Hence configure a fraction of ***carbon.number.of.cores.while.loading***. |
+| carbon.concurrent.lock.retries | 100 | CarbonData supports concurrent data loading onto same table. To ensure the loading status is correctly updated into the system,locks are used to sequence the status updation step. This configuration specifies the maximum number of retries to obtain the lock for updating the load status. **NOTE:** This value is high as more number of concurrent loading happens,more the chances of not able to obtain the lock when tried. Adjust this value according to the number of concurrent loading to be supported by the system. |
+| carbon.concurrent.lock.retry.timeout.sec | 1 | Specifies the interval between the retries to obtain the lock for concurrent operations. **NOTE:** Refer to ***carbon.concurrent.lock.retries*** for understanding why CarbonData uses locks during data loading operations. |
+| carbon.skip.empty.line | false | The csv files givent to CarbonData for loading can contain empty lines. Based on the business scenario, this empty line might have to be ignored or needs to be treated as NULL value for all columns.In order to define this business behavior, this configuration is provided.**NOTE:** In order to consider NULL values for non string columns and continue with data load, ***carbon.bad.records.action*** need to be set to **FORCE**;else data load will be failed as bad records encountered. |
+| carbon.enable.calculate.size | true | **For Load Operation**: Setting this property calculates the size of the carbon data file (.carbondata) and carbon index file (.carbonindex) for every load and updates the table status file. **For Describe Formatted**: Setting this property calculates the total size of the carbon data files and carbon index files for the respective table and displays in describe formatted command. **NOTE:** This is useful to determine the overall size of the carbondata table and also get an idea of how the table is growing in order to take up other backup strategy decisions. |
| carbon.cutOffTimestamp | (none) | CarbonData has capability to generate the Dictionary values for the timestamp columns from the data itself without the need to store the computed dictionary values. This configuration sets the start date for calculating the timestamp. Java counts the number of milliseconds from start of "1970-01-01 00:00:00". This property is used to customize the start of position. For example "2000-01-01 00:00:00". **NOTE:** The date must be in the form ***carbon.timestamp.format***. CarbonData supports storing data for upto 68 years.For example, if the cut-off time is 1970-01-01 05:30:00, then data upto 2038-01-01 05:30:00 will be supported by CarbonData. |
-| carbon.timegranularity | SECOND | The configuration is used to specify the data granularity level such as DAY, HOUR, MINUTE, or SECOND.This helps to store more than 68 years of data into CarbonData. |
-| carbon.use.local.dir | false | CarbonData,during data loading, writes files to local temp directories before copying the files to HDFS.This configuration is used to specify whether CarbonData can write locally to tmp directory of the container or to the YARN application directory. |
-| carbon.use.multiple.temp.dir | false | When multiple disks are present in the system, YARN is generally configured with multiple disks to be used as temp directories for managing the containers.This configuration specifies whether to use multiple YARN local directories during data loading for disk IO load balancing.Enable ***carbon.use.local.dir*** for this configuration to take effect.**NOTE:** Data Loading is an IO intensive operation whose performance can be limited by the disk IO threshold, particularly during multi table concurrent data load.Configuring this parameter, balances the disk IO across multiple disks there by improving the over all load performance. |
-| carbon.sort.temp.compressor | (none) | CarbonData writes every ***carbon.sort.size*** number of records to intermediate temp files during data loading to ensure memory footprint is within limits.These temporary files cab be compressed and written in order to save the storage space.This configuration specifies the name of compressor to be used to compress the intermediate sort temp files during sort procedure in data loading.The valid values are 'SNAPPY','GZIP','BZIP2','LZ4','ZSTD' and empty. By default, empty means that Carbondata will not compress the sort temp files.**NOTE:** Compressor will be useful if you encounter disk bottleneck.Since the data needs to be compressed and decompressed,it involves additional CPU cycles,but is compensated by the high IO throughput due to less data to be written or read from the disks. |
-| carbon.load.skewedDataOptimization.enabled | false | During data loading,CarbonData would divide the number of blocks equally so as to ensure all executors process same number of blocks.This mechanism satisfies most of the scenarios and ensures maximum parallel processing for optimal data loading performance.In some business scenarios, there might be scenarios where the size of blocks vary significantly and hence some executors would have to do more work if they get blocks containing more data. This configuration enables size based block allocation strategy for data loading.When loading, carbondata will use file size based block allocation strategy for task distribution. It will make sure that all the executors process the same size of data.**NOTE:** This configuration is useful if the size of your input data files varies widely, say 1MB~1GB.For this configuration to work effectively,knowing the data pattern and size is important and necessary. |
-| carbon.load.min.size.enabled | false | During Data Loading, CarbonData would divide the number of files among the available executors to parallelize the loading operation.When the input data files are very small, this action causes to generate many small carbondata files.This configuration determines whether to enable node minumun input data size allocation strategy for data loading.It will make sure that the node load the minimum amount of data there by reducing number of carbondata files.**NOTE:** This configuration is useful if the size of the input data files are very small, like 1MB~256MB.Refer to ***load_min_size_inmb*** to configure the minimum size to be considered for splitting files among executors. |
-| enable.data.loading.statistics | false | CarbonData has extensive logging which would be useful for debugging issues related to performance or hard to locate issues.This configuration when made ***true*** would log additional data loading statistics information to more accurately locate the issues being debugged.**NOTE:** Enabling this would log more debug information to log files, there by increasing the log files size significantly in short span of time.It is advised to configure the log files size, retention of log files parameters in log4j properties appropriately.Also extensive logging is an increased IO operation and hence over all data loading performance might get reduced.Therefore it is recommened to enable this configuration only for the duration of debugging. |
-| carbon.dictionary.chunk.size | 10000 | CarbonData generates dictionary keys and writes them to separate dictionary file during data loading.To optimize the IO, this configuration determines the number of dictionary keys to be persisted to dictionary file at a time.**NOTE:** Writing to file also serves as a commit point to the dictionary generated.Increasing more values in memory causes more data loss during system or application failure.It is advised to alter this configuration judiciously. |
-| dictionary.worker.threads | 1 | CarbonData supports Optimized data loading by relying on a dictionary server.Dictionary server helps to maintain dictionary values independent of the data loading and there by avoids reading the same input data multiples times.This configuration determines the number of concurrent dictionary generation or request that needs to be served by the dictionary server.**NOTE:** This configuration takes effect when ***carbon.options.single.pass*** is configured as true.Please refer to *carbon.options.single.pass*to understand how dictionary server optimizes data loading. |
-| enable.unsafe.sort | true | CarbonData supports unsafe operations of Java to avoid GC overhead for certain operations.This configuration enables to use unsafe functions in CarbonData.**NOTE:** For operations like data loading, which generates more short lived Java objects, Java GC can be a bottle neck.Using unsafe can overcome the GC overhead and improve the overall performance. |
-| enable.offheap.sort | true | CarbonData supports storing data in off-heap memory for certain operations during data loading and query.This helps to avoid the Java GC and thereby improve the overall performance.This configuration enables using off-heap memory for sorting of data during data loading.**NOTE:** ***enable.unsafe.sort*** configuration needs to be configured to true for using off-heap |
-| enable.inmemory.merge.sort | false | CarbonData sorts and writes data to intermediate files to limit the memory usage.These intermediate files needs to be sorted again using merge sort before writing to the final carbondata file.Performing merge sort in memory would increase the sorting performance at the cost of increased memory footprint. This Configuration specifies to do in-memory merge sort or to do file based merge sort. |
-| carbon.load.sort.scope | LOCAL_SORT | CarbonData can support various sorting options to match the balance between load and query performance.LOCAL_SORT:All the data given to an executor in the single load is fully sorted and written to carondata files.Data loading performance is reduced a little as the entire data needs to be sorted in the executor.BATCH_SORT:Sorts the data in batches of configured size and writes to carbondata files.Data loading performance increases as the entire data need not be sorted.But query performance will get reduced due to false positives in block pruning and also due to more number of carbondata files written.Due to more number of carbondata files, if identified blocks > cluster parallelism, query performance and concurrency will get reduced.GLOBAL SORT:Entire data in the data load is fully sorted and written to carbondata files.Data loading perfromance would get reduced as the entire data needs to be sorted.But the query performance increases signific
antly due to very less false positives and concurrency is also improved.**NOTE:** when BATCH_SORTis configured, it is recommended to keep ***carbon.load.batch.sort.size.inmb*** > ***carbon.blockletgroup.size.in.mb*** |
-| carbon.load.batch.sort.size.inmb | 0 | When ***carbon.load.sort.scope*** is configured as ***BATCH_SORT***,This configuration needs to be added to specify the batch size for sorting and writing to carbondata files.**NOTE:** It is recommended to keep the value around 45% of ***carbon.sort.storage.inmemory.size.inmb*** to avoid spill to disk.Also it is recommended to keep the value higher than ***carbon.blockletgroup.size.in.mb***. Refer to *carbon.load.sort.scope* for more information on sort options and the advantages/disadvantges of each option. |
-| carbon.dictionary.server.port | 2030 | 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.Single pass loading can be enabled using the option ***carbon.options.single.pass***.When this option is specified, a dictionary server will be internally started to handle the dictionary generation and query requests.This configuration specifies the port on which the server need to listen for incoming requests.Port value ranges between 0-65535 |
-| carbon.merge.sort.prefetch | true | CarbonData writes every ***carbon.sort.size*** number of records to intermediate temp files during data loading to ensure memory footprint is within limits.These intermediate temp files will have to be sorted using merge sort before writing into CarbonData format.This configuration enables pre fetching of data from these temp files in order to optimize IO and speed up data loading process. |
-| carbon.loading.prefetch | false | CarbonData uses univocity parser to read csv files.This configuration is used to inform the parser whether it can prefetch the data from csv files to speed up the reading.**NOTE:** Enabling prefetch improves the data loading performance, but needs higher memory to keep more records which are read ahead from disk. |
-| carbon.prefetch.buffersize | 1000 | When the configuration ***carbon.merge.sort.prefetch*** is configured to true, we need to set the number of records that can be prefetched.This configuration is used specify the number of records to be prefetched.**NOTE: **Configuring more number of records to be prefetched increases memory footprint as more records will have to be kept in memory. |
-| load_min_size_inmb | 256 | This configuration is used along with ***carbon.load.min.size.enabled***.This determines the minimum size of input files to be considered for distribution among executors while data loading.**NOTE:** Refer to ***carbon.load.min.size.enabled*** for understanding when this configuration needs to be used and its advantages and disadvantages. |
-| carbon.load.sortmemory.spill.percentage | 0 | During data loading, some data pages are kept in memory upto memory configured in ***carbon.sort.storage.inmemory.size.inmb*** beyond which they are spilled to disk as intermediate temporary sort files.This configuration determines after what percentage data needs to be spilled to disk.**NOTE:** Without this configuration, when the data pages occupy upto configured memory, new data pages would be dumped to disk and old pages are still maintained in disk. |
-| carbon.load.directWriteHdfs.enabled | false | During data load all the carbondata files are written to local disk and finally copied to the target location in HDFS.Enabling this parameter will make carrbondata files to be written directly onto target HDFS location bypassing the local disk.**NOTE:** Writing directly to HDFS saves local disk IO(once for writing the files and again for copying to HDFS) there by improving the performance.But the drawback is when data loading fails or the application crashes, unwanted carbondata files will remain in the target HDFS location until it is cleared during next data load or by running *CLEAN FILES* DDL command |
-| carbon.options.serialization.null.format | \N | Based on the business scenarios, some columns might need to be loaded with null values.As null value cannot be written in csv files, some special characters might be adopted to specify null values.This configuration can be used to specify the null values format in the data being loaded. |
-| carbon.sort.storage.inmemory.size.inmb | 512 | CarbonData writes every ***carbon.sort.size*** number of records to intermediate temp files during data loading to ensure memory footprint is within limits.When ***enable.unsafe.sort*** configuration is enabled, instead of using ***carbon.sort.size*** which is based on rows count, size occupied in memory is used to determine when to flush data pages to intermediate temp files.This configuration determines the memory to be used for storing data pages in memory.**NOTE:** Configuring a higher values ensures more data is maintained in memory and hence increases data loading performance due to reduced or no IO.Based on the memory availability in the nodes of the cluster, configure the values accordingly. |
+| carbon.timegranularity | SECOND | The configuration is used to specify the data granularity level such as DAY, HOUR, MINUTE, or SECOND. This helps to store more than 68 years of data into CarbonData. |
+| carbon.use.local.dir | false | CarbonData,during data loading, writes files to local temp directories before copying the files to HDFS. This configuration is used to specify whether CarbonData can write locally to tmp directory of the container or to the YARN application directory. |
+| carbon.use.multiple.temp.dir | false | When multiple disks are present in the system, YARN is generally configured with multiple disks to be used as temp directories for managing the containers. This configuration specifies whether to use multiple YARN local directories during data loading for disk IO load balancing.Enable ***carbon.use.local.dir*** for this configuration to take effect. **NOTE:** Data Loading is an IO intensive operation whose performance can be limited by the disk IO threshold, particularly during multi table concurrent data load.Configuring this parameter, balances the disk IO across multiple disks there by improving the over all load performance. |
+| carbon.sort.temp.compressor | (none) | CarbonData writes every ***carbon.sort.size*** number of records to intermediate temp files during data loading to ensure memory footprint is within limits. These temporary files can be compressed and written in order to save the storage space. This configuration specifies the name of compressor to be used to compress the intermediate sort temp files during sort procedure in data loading. The valid values are 'SNAPPY','GZIP','BZIP2','LZ4','ZSTD' and empty. By default, empty means that Carbondata will not compress the sort temp files. **NOTE:** Compressor will be useful if you encounter disk bottleneck.Since the data needs to be compressed and decompressed,it involves additional CPU cycles,but is compensated by the high IO throughput due to less data to be written or read from the disks. |
+| carbon.load.skewedDataOptimization.enabled | false | During data loading,CarbonData would divide the number of blocks equally so as to ensure all executors process same number of blocks. This mechanism satisfies most of the scenarios and ensures maximum parallel processing for optimal data loading performance.In some business scenarios, there might be scenarios where the size of blocks vary significantly and hence some executors would have to do more work if they get blocks containing more data. This configuration enables size based block allocation strategy for data loading. When loading, carbondata will use file size based block allocation strategy for task distribution. It will make sure that all the executors process the same size of data.**NOTE:** This configuration is useful if the size of your input data files varies widely, say 1MB to 1GB.For this configuration to work effectively,knowing the data pattern and size is important and necessary. |
+| carbon.load.min.size.enabled | false | During Data Loading, CarbonData would divide the number of files among the available executors to parallelize the loading operation. When the input data files are very small, this action causes to generate many small carbondata files. This configuration determines whether to enable node minumun input data size allocation strategy for data loading.It will make sure that the node load the minimum amount of data there by reducing number of carbondata files.**NOTE:** This configuration is useful if the size of the input data files are very small, like 1MB to 256MB.Refer to ***load_min_size_inmb*** to configure the minimum size to be considered for splitting files among executors. |
+| enable.data.loading.statistics | false | CarbonData has extensive logging which would be useful for debugging issues related to performance or hard to locate issues. This configuration when made ***true*** would log additional data loading statistics information to more accurately locate the issues being debugged. **NOTE:** Enabling this would log more debug information to log files, there by increasing the log files size significantly in short span of time.It is advised to configure the log files size, retention of log files parameters in log4j properties appropriately. Also extensive logging is an increased IO operation and hence over all data loading performance might get reduced. Therefore it is recommended to enable this configuration only for the duration of debugging. |
+| carbon.dictionary.chunk.size | 10000 | CarbonData generates dictionary keys and writes them to separate dictionary file during data loading. To optimize the IO, this configuration determines the number of dictionary keys to be persisted to dictionary file at a time. **NOTE:** Writing to file also serves as a commit point to the dictionary generated.Increasing more values in memory causes more data loss during system or application failure.It is advised to alter this configuration judiciously. |
+| dictionary.worker.threads | 1 | CarbonData supports Optimized data loading by relying on a dictionary server. Dictionary server helps to maintain dictionary values independent of the data loading and there by avoids reading the same input data multiples times. This configuration determines the number of concurrent dictionary generation or request that needs to be served by the dictionary server. **NOTE:** This configuration takes effect when ***carbon.options.single.pass*** is configured as true.Please refer to *carbon.options.single.pass*to understand how dictionary server optimizes data loading. |
+| enable.unsafe.sort | true | CarbonData supports unsafe operations of Java to avoid GC overhead for certain operations. This configuration enables to use unsafe functions in CarbonData. **NOTE:** For operations like data loading, which generates more short lived Java objects, Java GC can be a bottle neck. Using unsafe can overcome the GC overhead and improve the overall performance. |
+| enable.offheap.sort | true | CarbonData supports storing data in off-heap memory for certain operations during data loading and query. This helps to avoid the Java GC and thereby improve the overall performance. This configuration enables using off-heap memory for sorting of data during data loading.**NOTE:** ***enable.unsafe.sort*** configuration needs to be configured to true for using off-heap |
+| enable.inmemory.merge.sort | false | CarbonData sorts and writes data to intermediate files to limit the memory usage. These intermediate files needs to be sorted again using merge sort before writing to the final carbondata file.Performing merge sort in memory would increase the sorting performance at the cost of increased memory footprint. This Configuration specifies to do in-memory merge sort or to do file based merge sort. |
+| carbon.load.sort.scope | LOCAL_SORT | CarbonData can support various sorting options to match the balance between load and query performance. LOCAL_SORT:All the data given to an executor in the single load is fully sorted and written to carbondata files. Data loading performance is reduced a little as the entire data needs to be sorted in the executor. BATCH_SORT:Sorts the data in batches of configured size and writes to carbondata files. Data loading performance increases as the entire data need not be sorted.But query performance will get reduced due to false positives in block pruning and also due to more number of carbondata files written.Due to more number of carbondata files, if identified blocks > cluster parallelism, query performance and concurrency will get reduced.GLOBAL SORT:Entire data in the data load is fully sorted and written to carbondata files. Data loading performance would get reduced as the entire data needs to be sorted.But the query performance increases si
gnificantly due to very less false positives and concurrency is also improved. **NOTE:** when BATCH_SORT is configured, it is recommended to keep ***carbon.load.batch.sort.size.inmb*** > ***carbon.blockletgroup.size.in.mb*** |
+| carbon.load.batch.sort.size.inmb | 0 | When ***carbon.load.sort.scope*** is configured as ***BATCH_SORT***, this configuration needs to be added to specify the batch size for sorting and writing to carbondata files. **NOTE:** It is recommended to keep the value around 45% of ***carbon.sort.storage.inmemory.size.inmb*** to avoid spill to disk. Also it is recommended to keep the value higher than ***carbon.blockletgroup.size.in.mb***. Refer to *carbon.load.sort.scope* for more information on sort options and the advantages/disadvantages of each option. |
+| carbon.dictionary.server.port | 2030 | 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.Single pass loading can be enabled using the option ***carbon.options.single.pass***. When this option is specified, a dictionary server will be internally started to handle the dictionary generation and query requests. This configuration specifies the port on which the server need to listen for incoming requests.Port value ranges between 0-65535 |
+| carbon.merge.sort.prefetch | true | CarbonData writes every ***carbon.sort.size*** number of records to intermediate temp files during data loading to ensure memory footprint is within limits. These intermediate temp files will have to be sorted using merge sort before writing into CarbonData format. This configuration enables pre fetching of data from these temp files in order to optimize IO and speed up data loading process. |
+| carbon.loading.prefetch | false | CarbonData uses univocity parser to read csv files. This configuration is used to inform the parser whether it can prefetch the data from csv files to speed up the reading.**NOTE:** Enabling prefetch improves the data loading performance, but needs higher memory to keep more records which are read ahead from disk. |
+| carbon.prefetch.buffersize | 1000 | When the configuration ***carbon.merge.sort.prefetch*** is configured to true, we need to set the number of records that can be prefetched. This configuration is used specify the number of records to be prefetched.**NOTE: **Configuring more number of records to be prefetched increases memory footprint as more records will have to be kept in memory. |
+| load_min_size_inmb | 256 | This configuration is used along with ***carbon.load.min.size.enabled***. This determines the minimum size of input files to be considered for distribution among executors while data loading.**NOTE:** Refer to ***carbon.load.min.size.enabled*** for understanding when this configuration needs to be used and its advantages and disadvantages. |
+| carbon.load.sortmemory.spill.percentage | 0 | During data loading, some data pages are kept in memory upto memory configured in ***carbon.sort.storage.inmemory.size.inmb*** beyond which they are spilled to disk as intermediate temporary sort files. This configuration determines after what percentage data needs to be spilled to disk. **NOTE:** Without this configuration, when the data pages occupy upto configured memory, new data pages would be dumped to disk and old pages are still maintained in disk. |
+| carbon.load.directWriteToStorePath.enabled | false | During data load, all the carbondata files are written to local disk and finally copied to the target store location in HDFS/S3. Enabling this parameter will make carbondata files to be written directly onto target HDFS/S3 location bypassing the local disk.**NOTE:** Writing directly to HDFS/S3 saves local disk IO(once for writing the files and again for copying to HDFS/S3) there by improving the performance. But the drawback is when data loading fails or the application crashes, unwanted carbondata files will remain in the target HDFS/S3 location until it is cleared during next data load or by running *CLEAN FILES* DDL command |
+| carbon.options.serialization.null.format | \N | Based on the business scenarios, some columns might need to be loaded with null values. As null value cannot be written in csv files, some special characters might be adopted to specify null values. This configuration can be used to specify the null values format in the data being loaded. |
+| carbon.sort.storage.inmemory.size.inmb | 512 | CarbonData writes every ***carbon.sort.size*** number of records to intermediate temp files during data loading to ensure memory footprint is within limits. When ***enable.unsafe.sort*** configuration is enabled, instead of using ***carbon.sort.size*** which is based on rows count, size occupied in memory is used to determine when to flush data pages to intermediate temp files. This configuration determines the memory to be used for storing data pages in memory. **NOTE:** Configuring a higher value ensures more data is maintained in memory and hence increases data loading performance due to reduced or no IO.Based on the memory availability in the nodes of the cluster, configure the values accordingly. |
+| carbon.column.compressor | snappy | CarbonData will compress the column values using the compressor specified by this configuration. Currently CarbonData supports 'snappy' and 'zstd' compressors. |
+| carbon.minmax.allowed.byte.count | 200 | CarbonData will write the min max values for string/varchar types column using the byte count specified by this configuration. Max value is 1000 bytes(500 characters) and Min value is 10 bytes(5 characters). **NOTE:** This property is useful for reducing the store size thereby improving the query performance but can lead to query degradation if value is not configured properly. | |
## Compaction Configuration
| Parameter | Default Value | Description |
|-----------------------------------------------|---------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| carbon.number.of.cores.while.compacting | 2 | Number of cores to be used while compacting data.This also determines the number of threads to be used to read carbondata files in parallel. |
-| carbon.compaction.level.threshold | 4, 3 | Each CarbonData load will create one segment, if every load is small in size it will generate many small file over a period of time impacting the query performance.This configuration is for minor compaction which decides how many segments to be merged. Configuration is of the form (x,y). Compaction will be triggered for every x segments and form a single level 1 compacted segment.When the number of compacted level 1 segments reach y, compaction will be triggered again to merge them to form a single level 2 segment. For example: If it is set as 2, 3 then minor compaction will be triggered for every 2 segments. 3 is the number of level 1 compacted segments which is further compacted to new segment.**NOTE:** When ***carbon.enable.auto.load.merge*** is **true**, Configuring higher values cause overall data loading time to increase as compaction will be triggered after data loading is complete but status is not returned till compaction is comp
lete. But compacting more number of segments can increase query performance.Hence optimal values needs to be configured based on the business scenario.Valid values are bwteen 0 to 100. |
-| carbon.major.compaction.size | 1024 | To improve query performance and All the segments can be merged and compacted to a single segment upto configured size.This Major compaction size can be configured using this parameter. Sum of the segments which is below this threshold will be merged. This value is expressed in MB. |
-| carbon.horizontal.compaction.enable | true | CarbonData supports DELETE/UPDATE functionality by creating delta data files for existing carbondata files.These delta files would grow as more number of DELETE/UPDATE operations are performed.Compaction of these delta files are termed as horizontal compaction.This configuration is used to turn ON/OFF horizontal compaction. After every DELETE and UPDATE statement, horizontal compaction may occur in case the delta (DELETE/ UPDATE) files becomes more than specified threshold.**NOTE: **Having many delta files will reduce the query performance as scan has to happen on all these files before the final state of data can be decided.Hence it is advisable to keep horizontal compaction enabled and configure reasonable values to ***carbon.horizontal.UPDATE.compaction.threshold*** and ***carbon.horizontal.DELETE.compaction.threshold*** |
+| carbon.number.of.cores.while.compacting | 2 | Number of cores to be used while compacting data. This also determines the number of threads to be used to read carbondata files in parallel. |
+| carbon.compaction.level.threshold | 4, 3 | Each CarbonData load will create one segment, if every load is small in size it will generate many small file over a period of time impacting the query performance. This configuration is for minor compaction which decides how many segments to be merged. Configuration is of the form (x,y). Compaction will be triggered for every x segments and form a single level 1 compacted segment. When the number of compacted level 1 segments reach y, compaction will be triggered again to merge them to form a single level 2 segment. For example: If it is set as 2, 3 then minor compaction will be triggered for every 2 segments. 3 is the number of level 1 compacted segments which is further compacted to new segment.**NOTE:** When ***carbon.enable.auto.load.merge*** is **true**, configuring higher values cause overall data loading time to increase as compaction will be triggered after data loading is complete but status is not returned till compaction is co
mplete. But compacting more number of segments can increase query performance.Hence optimal values needs to be configured based on the business scenario. Valid values are between 0 to 100. |
+| carbon.major.compaction.size | 1024 | To improve query performance and all the segments can be merged and compacted to a single segment upto configured size. This Major compaction size can be configured using this parameter. Sum of the segments which is below this threshold will be merged. This value is expressed in MB. |
+| carbon.horizontal.compaction.enable | true | CarbonData supports DELETE/UPDATE functionality by creating delta data files for existing carbondata files. These delta files would grow as more number of DELETE/UPDATE operations are performed.Compaction of these delta files are termed as horizontal compaction. This configuration is used to turn ON/OFF horizontal compaction. After every DELETE and UPDATE statement, horizontal compaction may occur in case the delta (DELETE/ UPDATE) files becomes more than specified threshold.**NOTE: **Having many delta files will reduce the query performance as scan has to happen on all these files before the final state of data can be decided.Hence it is advisable to keep horizontal compaction enabled and configure reasonable values to ***carbon.horizontal.UPDATE.compaction.threshold*** and ***carbon.horizontal.DELETE.compaction.threshold*** |
| carbon.horizontal.update.compaction.threshold | 1 | This configuration specifies the threshold limit on number of UPDATE delta files within a segment. In case the number of delta files goes beyond the threshold, the UPDATE delta files within the segment becomes eligible for horizontal compaction and are compacted into single UPDATE delta file.Values range between 1 to 10000. |
| carbon.horizontal.delete.compaction.threshold | 1 | This configuration specifies the threshold limit on number of DELETE delta files within a block of a segment. In case the number of delta files goes beyond the threshold, the DELETE delta files for the particular block of the segment becomes eligible for horizontal compaction and are compacted into single DELETE delta file.Values range between 1 to 10000. |
-| carbon.update.segment.parallelism | 1 | CarbonData processes the UPDATE operations by grouping records belonging to a segment into a single executor task.When the amount of data to be updated is more, this behavior causes problems like restarting of executor due to low memory and data-spill related errors.This property specifies the parallelism for each segment during update.**NOTE:** It is recommended to set this value to a multiple of the number of executors for balance.Values range between 1 to 1000. |
+| carbon.update.segment.parallelism | 1 | CarbonData processes the UPDATE operations by grouping records belonging to a segment into a single executor task. When the amount of data to be updated is more, this behavior causes problems like restarting of executor due to low memory and data-spill related errors. This property specifies the parallelism for each segment during update.**NOTE:** It is recommended to set this value to a multiple of the number of executors for balance.Values range between 1 to 1000. |
| carbon.numberof.preserve.segments | 0 | If the user wants to preserve some number of segments from being compacted then he can set this configuration. Example: carbon.numberof.preserve.segments = 2 then 2 latest segments will always be excluded from the compaction. No segments will be preserved by default.**NOTE:** This configuration is useful when the chances of input data can be wrong due to environment scenarios.Preserving some of the latest segments from being compacted can help to easily delete the wrongly loaded segments.Once compacted,it becomes more difficult to determine the exact data to be deleted(except when data is incrementing according to time) |
-| carbon.allowed.compaction.days | 0 | This configuration is used to control on the number of recent segments that needs to be compacted, ignoring the older ones.This congifuration is in days.For Example: If the configuration is 2, then the segments which are loaded in the time frame of past 2 days only will get merged. Segments which are loaded earlier than 2 days will not be merged. This configuration is disabled by default.**NOTE:** This configuration is useful when a bulk of history data is loaded into the carbondata.Query on this data is less frequent.In such cases involving these segments also into compacation will affect the resource consumption, increases overall compaction time. |
-| carbon.enable.auto.load.merge | false | Compaction can be automatically triggered once data load completes.This ensures that the segments are merged in time and thus query times doesnt increase with increase in segments.This configuration enables to do compaction along with data loading.**NOTE: **Compaction will be triggered once the data load completes.But the status of data load wait till the compaction is completed.Hence it might look like data loading time has increased, but thats not the case.Moreover failure of compaction will not affect the data loading status.If data load had completed successfully, the status would be updated and segments are committed.However, failure while data loading, will not trigger compaction and error is returned immediately. |
-| carbon.enable.page.level.reader.in.compaction|true|Enabling page level reader for compaction reduces the memory usage while compacting more number of segments. It allows reading only page by page instead of reading whole blocklet to memory.**NOTE:** Please refer to [file-structure-of-carbondata](./file-structure-of-carbondata.md#carbondata-file-format) to understand the storage format of CarbonData and concepts of pages.|
-| carbon.concurrent.compaction | true | Compaction of different tables can be executed concurrently.This configuration determines whether to compact all qualifying tables in parallel or not.**NOTE: **Compacting concurrently is a resource demanding operation and needs more resouces there by affecting the query performance also.This configuration is **deprecated** and might be removed in future releases. |
-| carbon.compaction.prefetch.enable | false | Compaction operation is similar to Query + data load where in data from qualifying segments are queried and data loading performed to generate a new single segment.This configuration determines whether to query ahead data from segments and feed it for data loading.**NOTE: **This configuration is disabled by default as it needs extra resources for querying ahead extra data.Based on the memory availability on the cluster, user can enable it to improve compaction performance. |
-| carbon.merge.index.in.segment | true | Each CarbonData file has a companion CarbonIndex file which maintains the metadata about the data.These CarbonIndex files are read and loaded into driver and is used subsequently for pruning of data during queries.These CarbonIndex files are very small in size(few KB) and are many.Reading many small files from HDFS is not efficient and leads to slow IO performance.Hence these CarbonIndex files belonging to a segment can be combined into a single file and read once there by increasing the IO throughput.This configuration enables to merge all the CarbonIndex files into a single MergeIndex file upon data loading completion.**NOTE:** Reading a single big file is more efficient in HDFS and IO throughput is very high.Due to this the time needed to load the index files into memory when query is received for the first time on that table is significantly reduced and there by significantly reduces the delay in serving the first query. |
+| carbon.allowed.compaction.days | 0 | This configuration is used to control on the number of recent segments that needs to be compacted, ignoring the older ones. This configuration is in days.For Example: If the configuration is 2, then the segments which are loaded in the time frame of past 2 days only will get merged. Segments which are loaded earlier than 2 days will not be merged. This configuration is disabled by default.**NOTE:** This configuration is useful when a bulk of history data is loaded into the carbondata.Query on this data is less frequent.In such cases involving these segments also into compaction will affect the resource consumption, increases overall compaction time. |
+| carbon.enable.auto.load.merge | false | Compaction can be automatically triggered once data load completes. This ensures that the segments are merged in time and thus query times does not increase with increase in segments. This configuration enables to do compaction along with data loading.**NOTE: **Compaction will be triggered once the data load completes.But the status of data load wait till the compaction is completed.Hence it might look like data loading time has increased, but thats not the case.Moreover failure of compaction will not affect the data loading status.If data load had completed successfully, the status would be updated and segments are committed.However, failure while data loading, will not trigger compaction and error is returned immediately. |
+| carbon.enable.page.level.reader.in.compaction|true|Enabling page level reader for compaction reduces the memory usage while compacting more number of segments. It allows reading only page by page instead of reading whole blocklet to memory. **NOTE:** Please refer to [file-structure-of-carbondata](./file-structure-of-carbondata.md#carbondata-file-format) to understand the storage format of CarbonData and concepts of pages.|
+| carbon.concurrent.compaction | true | Compaction of different tables can be executed concurrently. This configuration determines whether to compact all qualifying tables in parallel or not. **NOTE: **Compacting concurrently is a resource demanding operation and needs more resources there by affecting the query performance also. This configuration is **deprecated** and might be removed in future releases. |
+| carbon.compaction.prefetch.enable | false | Compaction operation is similar to Query + data load where in data from qualifying segments are queried and data loading performed to generate a new single segment. This configuration determines whether to query ahead data from segments and feed it for data loading. **NOTE: **This configuration is disabled by default as it needs extra resources for querying extra data.Based on the memory availability on the cluster, user can enable it to improve compaction performance. |
+| carbon.merge.index.in.segment | true | Each CarbonData file has a companion CarbonIndex file which maintains the metadata about the data. These CarbonIndex files are read and loaded into driver and is used subsequently for pruning of data during queries. These CarbonIndex files are very small in size(few KB) and are many.Reading many small files from HDFS is not efficient and leads to slow IO performance.Hence these CarbonIndex files belonging to a segment can be combined into a single file and read once there by increasing the IO throughput. This configuration enables to merge all the CarbonIndex files into a single MergeIndex file upon data loading completion.**NOTE:** Reading a single big file is more efficient in HDFS and IO throughput is very high.Due to this the time needed to load the index files into memory when query is received for the first time on that table is significantly reduced and there by significantly reduces the delay in serving the first query. |
## Query Configuration
| Parameter | Default Value | Description |
|--------------------------------------|---------------|---------------------------------------------------|
-| carbon.max.driver.lru.cache.size | -1 | Maximum memory **(in MB)** upto which the driver process can cache the data (BTree and dictionary values). Beyond this, least recently used data will be removed from cache before loading new set of values.Default value of -1 means there is no memory limit for caching. Only integer values greater than 0 are accepted.**NOTE:** Minimum number of entries that needs to be removed from cache in order to load the new set of data is determined and unloaded.ie.,for example if 3 cache entries qualify for pre-emption, out of these, those entries that free up more cache memory is removed prior to others. |
-| carbon.max.executor.lru.cache.size | -1 | Maximum memory **(in MB)** upto which the executor process can cache the data (BTree and reverse dictionary values).Default value of -1 means there is no memory limit for caching. Only integer values greater than 0 are accepted.**NOTE:** If this parameter is not configured, then the value of ***carbon.max.driver.lru.cache.size*** will be used. |
+| carbon.max.driver.lru.cache.size | -1 | Maximum memory **(in MB)** upto which the driver process can cache the data (BTree and dictionary values). Beyond this, least recently used data will be removed from cache before loading new set of values.Default value of -1 means there is no memory limit for caching. Only integer values greater than 0 are accepted. **NOTE:** Minimum number of entries that needs to be removed from cache in order to load the new set of data is determined and unloaded.ie.,for example if 3 cache entries qualify for pre-emption, out of these, those entries that free up more cache memory is removed prior to others. Please refer [FAQs](./faq.md#how-to-check-lru-cache-memory-footprint) for checking LRU cache memory footprint. |
+| carbon.max.executor.lru.cache.size | -1 | Maximum memory **(in MB)** upto which the executor process can cache the data (BTree and reverse dictionary values).Default value of -1 means there is no memory limit for caching. Only integer values greater than 0 are accepted. **NOTE:** If this parameter is not configured, then the value of ***carbon.max.driver.lru.cache.size*** will be used. |
| max.query.execution.time | 60 | Maximum time allowed for one query to be executed. The value is in minutes. |
-| carbon.enableMinMax | true | CarbonData maintains the metadata which enables to prune unnecessary files from being scanned as per the query conditions.To achieve pruning, Min,Max of each column is maintined.Based on the filter condition in the query, certain data can be skipped from scanning by matching the filter value against the min,max values of the column(s) present in that carbondata file.This pruing enhances query performance significantly. |
-| carbon.dynamicallocation.schedulertimeout | 5 | CarbonData has its own scheduling algorithm to suggest to Spark on how many tasks needs to be launched and how much work each task need to do in a Spark cluster for any query on CarbonData.To determine the number of tasks that can be scheduled, knowing the count of active executors is necessary.When dynamic allocation is enabled on a YARN based spark cluster,execuor processes are shutdown if no request is received for a particular amount of time.The executors are brought up when the requet is received again.This configuration specifies the maximum time (unit in seconds) the carbon scheduler can wait for executor to be active. Minimum value is 5 sec and maximum value is 15 sec.**NOTE: **Waiting for longer time leads to slow query response time.Moreover it might be possible that YARN is not able to start the executors and waiting is not beneficial. |
-| carbon.scheduler.minregisteredresourcesratio | 0.8 | Specifies the minimum resource (executor) ratio needed for starting the block distribution. The default value is 0.8, which indicates 80% of the requested resource is allocated for starting block distribution. The minimum value is 0.1 min and the maximum value is 1.0. |
+| carbon.enableMinMax | true | CarbonData maintains the metadata which enables to prune unnecessary files from being scanned as per the query conditions. To achieve pruning, Min,Max of each column is maintined.Based on the filter condition in the query, certain data can be skipped from scanning by matching the filter value against the min,max values of the column(s) present in that carbondata file. This pruning enhances query performance significantly. |
+| carbon.dynamicallocation.schedulertimeout | 5 | CarbonData has its own scheduling algorithm to suggest to Spark on how many tasks needs to be launched and how much work each task need to do in a Spark cluster for any query on CarbonData. To determine the number of tasks that can be scheduled, knowing the count of active executors is necessary. When dynamic allocation is enabled on a YARN based spark cluster, executor processes are shutdown if no request is received for a particular amount of time. The executors are brought up when the requet is received again. This configuration specifies the maximum time (unit in seconds) the carbon scheduler can wait for executor to be active. Minimum value is 5 sec and maximum value is 15 sec.**NOTE: **Waiting for longer time leads to slow query response time.Moreover it might be possible that YARN is not able to start the executors and waiting is not beneficial. |
+| carbon.scheduler.minregisteredresourcesratio | 0.8 | Specifies the minimum resource (executor) ratio needed for starting the block distribution. The default value is 0.8, which indicates 80% of the requested resource is allocated for starting block distribution. The minimum value is 0.1 min and the maximum value is 1.0. |
| carbon.search.enabled (Alpha Feature) | false | If set to true, it will use CarbonReader to do distributed scan directly instead of using compute framework like spark, thus avoiding limitation of compute framework like SQL optimizer and task scheduling overhead. |
-| carbon.search.query.timeout | 10s | Time within which the result is expected from the workers;beyond which the query is terminated |
+| carbon.search.query.timeout | 10s | Time within which the result is expected from the workers, beyond which the query is terminated |
| carbon.search.scan.thread | num of cores available in worker node | Number of cores to be used in each worker for performing scan. |
| carbon.search.master.port | 10020 | Port on which the search master listens for incoming query requests |
| carbon.search.worker.port | 10021 | Port on which search master communicates with the workers. |
| carbon.search.worker.workload.limit | 10 * *carbon.search.scan.thread* | Maximum number of active requests that can be sent to a worker.Beyond which the request needs to be rescheduled for later time or to a different worker. |
| carbon.detail.batch.size | 100 | The buffer size to store records, returned from the block scan. In limit scenario this parameter is very important. For example your query limit is 1000. But if we set this value to 3000 that means we get 3000 records from scan but spark will only take 1000 rows. So the 2000 remaining are useless. In one Finance test case after we set it to 100, in the limit 1000 scenario the performance increase about 2 times in comparison to if we set this value to 12000. |
-| carbon.enable.vector.reader | true | Spark added vector processing to optimize cpu cache miss and there by increase the query performance.This configuration enables to fetch data as columnar batch of size 4*1024 rows instead of fetching data row by row and provide it to spark so that there is improvement in select queries performance. |
+| carbon.enable.vector.reader | true | Spark added vector processing to optimize cpu cache miss and there by increase the query performance. This configuration enables to fetch data as columnar batch of size 4*1024 rows instead of fetching data row by row and provide it to spark so that there is improvement in select queries performance. |
| carbon.task.distribution | block | CarbonData has its own scheduling algorithm to suggest to Spark on how many tasks needs to be launched and how much work each task need to do in a Spark cluster for any query on CarbonData.Each of these task distribution suggestions has its own advantages and disadvantages.Based on the customer use case, appropriate task distribution can be configured.**block**: Setting this value will launch one task per block. This setting is suggested in case of concurrent queries and queries having big shuffling scenarios. **custom**: Setting this value will group the blocks and distribute it uniformly to the available resources in the cluster. This enhances the query performance but not suggested in case of concurrent queries and queries having big shuffling scenarios. **blocklet**: Setting this value will launch one task per blocklet. This setting is suggested in case of concurrent queries and queries having big shuffling scenarios. **merge_small_files**: S
etting this value will merge all the small carbondata files upto a bigger size configured by ***spark.sql.files.maxPartitionBytes*** (128 MB is the default value,it is configurable) during querying. The small carbondata files are combined to a map task to reduce the number of read task. This enhances the performance. |
-| carbon.custom.block.distribution | false | CarbonData has its own scheduling algorithm to suggest to Spark on how many tasks needs to be launched and how much work each task need to do in a Spark cluster for any query on CarbonData.When this configuration is true, CarbonData would distribute the available blocks to be scanned among the available number of cores.For Example:If there are 10 blocks to be scanned and only 3 tasks can be run(only 3 executor cores available in the cluster), CarbonData would combine blocks as 4,3,3 and give it to 3 tasks to run.**NOTE:** When this configuration is false, as per the ***carbon.task.distribution*** configuration, each block/blocklet would be given to each task. |
-| enable.query.statistics | false | CarbonData has extensive logging which would be useful for debugging issues related to performance or hard to locate issues.This configuration when made ***true*** would log additional query statistics information to more accurately locate the issues being debugged.**NOTE:** Enabling this would log more debug information to log files, there by increasing the log files size significantly in short span of time.It is advised to configure the log files size, retention of log files parameters in log4j properties appropriately.Also extensive logging is an increased IO operation and hence over all query performance might get reduced.Therefore it is recommened to enable this configuration only for the duration of debugging. |
-| enable.unsafe.in.query.processing | true | CarbonData supports unsafe operations of Java to avoid GC overhead for certain operations.This configuration enables to use unsafe functions in CarbonData while scanning the data during query. |
-| carbon.query.validate.directqueryondatamap | true | CarbonData supports creating pre-aggregate table datamaps as an independent tables.For some debugging purposes, it might be required to directly query from such datamap tables.This configuration allows to query on such datamaps. |
-| carbon.heap.memory.pooling.threshold.bytes | 1048576 | CarbonData supports unsafe operations of Java to avoid GC overhead for certain operations.Using unsafe, memory can be allocated on Java Heap or off heap.This configuration controlls the allocation mechanism on Java HEAP.If the heap memory allocations of the given size is greater or equal than this value,it should go through the pooling mechanism.But if set this size to -1, it should not go through the pooling mechanism.Default value is 1048576(1MB, the same as Spark).Value to be specified in bytes. |
+| carbon.custom.block.distribution | false | CarbonData has its own scheduling algorithm to suggest to Spark on how many tasks needs to be launched and how much work each task need to do in a Spark cluster for any query on CarbonData. When this configuration is true, CarbonData would distribute the available blocks to be scanned among the available number of cores.For Example:If there are 10 blocks to be scanned and only 3 tasks can be run(only 3 executor cores available in the cluster), CarbonData would combine blocks as 4,3,3 and give it to 3 tasks to run. **NOTE:** When this configuration is false, as per the ***carbon.task.distribution*** configuration, each block/blocklet would be given to each task. |
+| enable.query.statistics | false | CarbonData has extensive logging which would be useful for debugging issues related to performance or hard to locate issues. This configuration when made ***true*** would log additional query statistics information to more accurately locate the issues being debugged.**NOTE:** Enabling this would log more debug information to log files, there by increasing the log files size significantly in short span of time.It is advised to configure the log files size, retention of log files parameters in log4j properties appropriately. Also extensive logging is an increased IO operation and hence over all query performance might get reduced. Therefore it is recommended to enable this configuration only for the duration of debugging. |
+| enable.unsafe.in.query.processing | false | CarbonData supports unsafe operations of Java to avoid GC overhead for certain operations. This configuration enables to use unsafe functions in CarbonData while scanning the data during query. |
+| carbon.query.validate.directqueryondatamap | true | CarbonData supports creating pre-aggregate table datamaps as an independent tables. For some debugging purposes, it might be required to directly query from such datamap tables. This configuration allows to query on such datamaps. |
+| carbon.heap.memory.pooling.threshold.bytes | 1048576 | CarbonData supports unsafe operations of Java to avoid GC overhead for certain operations. Using unsafe, memory can be allocated on Java Heap or off heap. This configuration controls the allocation mechanism on Java HEAP.If the heap memory allocations of the given size is greater or equal than this value,it should go through the pooling mechanism.But if set this size to -1, it should not go through the pooling mechanism.Default value is 1048576(1MB, the same as Spark).Value to be specified in bytes. |
## Data Mutation Configuration
| Parameter | Default Value | Description |
|--------------------------------------|---------------|---------------------------------------------------|
| carbon.insert.persist.enable | false | CarbonData does loading in 2 major steps.1st s
<TRUNCATED>
[09/20] carbondata-site git commit: modified for 1.5.0 version
Posted by ch...@apache.org.
http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6ad7599a/content/sdk-guide.html
----------------------------------------------------------------------
diff --git a/content/sdk-guide.html b/content/sdk-guide.html
index a252965..5ddf9f7 100644
--- a/content/sdk-guide.html
+++ b/content/sdk-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>
@@ -259,9 +267,9 @@ These SDK writer output contains just a carbondata and carbonindex files. No met
<span class="pl-smi">CarbonProperties</span><span class="pl-k">.</span>getInstance()<span class="pl-k">.</span>addProperty(<span class="pl-s"><span class="pl-pds">"</span>enable.offheap.sort<span class="pl-pds">"</span></span>, enableOffheap);
- <span class="pl-smi">CarbonWriterBuilder</span> builder <span class="pl-k">=</span> <span class="pl-smi">CarbonWriter</span><span class="pl-k">.</span>builder()<span class="pl-k">.</span>outputPath(path);
+ <span class="pl-smi">CarbonWriterBuilder</span> builder <span class="pl-k">=</span> <span class="pl-smi">CarbonWriter</span><span class="pl-k">.</span>builder()<span class="pl-k">.</span>outputPath(path)<span class="pl-k">.</span>withCsvInput(schema);
- <span class="pl-smi">CarbonWriter</span> writer <span class="pl-k">=</span> builder<span class="pl-k">.</span>buildWriterForCSVInput(schema);
+ <span class="pl-smi">CarbonWriter</span> writer <span class="pl-k">=</span> builder<span class="pl-k">.</span>build();
<span class="pl-k">int</span> rows <span class="pl-k">=</span> <span class="pl-c1">5</span>;
<span class="pl-k">for</span> (<span class="pl-k">int</span> i <span class="pl-k">=</span> <span class="pl-c1">0</span>; i <span class="pl-k"><</span> rows; i<span class="pl-k">++</span>) {
@@ -314,7 +322,7 @@ These SDK writer output contains just a carbondata and carbonindex files. No met
<span class="pl-k">try</span> {
<span class="pl-smi">CarbonWriter</span> writer <span class="pl-k">=</span> <span class="pl-smi">CarbonWriter</span><span class="pl-k">.</span>builder()
.outputPath(path)
- .buildWriterForAvroInput(<span class="pl-k">new</span> <span class="pl-smi">org.apache.avro<span class="pl-k">.</span>Schema</span>.<span class="pl-smi">Parser</span>()<span class="pl-k">.</span>parse(avroSchema));
+ .withAvroInput(<span class="pl-k">new</span> <span class="pl-smi">org.apache.avro<span class="pl-k">.</span>Schema</span>.<span class="pl-smi">Parser</span>()<span class="pl-k">.</span>parse(avroSchema))<span class="pl-k">.</span>build();
<span class="pl-k">for</span> (<span class="pl-k">int</span> i <span class="pl-k">=</span> <span class="pl-c1">0</span>; i <span class="pl-k"><</span> <span class="pl-c1">100</span>; i<span class="pl-k">++</span>) {
writer<span class="pl-k">.</span>write(record);
@@ -352,10 +360,10 @@ These SDK writer output contains just a carbondata and carbonindex files. No met
<span class="pl-smi">Schema</span> <span class="pl-smi">CarbonSchema</span> <span class="pl-k">=</span> <span class="pl-k">new</span> <span class="pl-smi">Schema</span>(fields);
- <span class="pl-smi">CarbonWriterBuilder</span> builder <span class="pl-k">=</span> <span class="pl-smi">CarbonWriter</span><span class="pl-k">.</span>builder()<span class="pl-k">.</span>outputPath(path);
+ <span class="pl-smi">CarbonWriterBuilder</span> builder <span class="pl-k">=</span> <span class="pl-smi">CarbonWriter</span><span class="pl-k">.</span>builder()<span class="pl-k">.</span>outputPath(path)<span class="pl-k">.</span>withJsonInput(<span class="pl-smi">CarbonSchema</span>);
<span class="pl-c"><span class="pl-c">//</span> initialize json writer with carbon schema</span>
- <span class="pl-smi">CarbonWriter</span> writer <span class="pl-k">=</span> builder<span class="pl-k">.</span>buildWriterForJsonInput(<span class="pl-smi">CarbonSchema</span>);
+ <span class="pl-smi">CarbonWriter</span> writer <span class="pl-k">=</span> builder<span class="pl-k">.</span>build();
<span class="pl-c"><span class="pl-c">//</span> one row of json Data as String</span>
<span class="pl-smi">String</span> <span class="pl-smi">JsonRow</span> <span class="pl-k">=</span> <span class="pl-s"><span class="pl-pds">"</span>{<span class="pl-cce">\"</span>name<span class="pl-cce">\"</span>:<span class="pl-cce">\"</span>abcd<span class="pl-cce">\"</span>, <span class="pl-cce">\"</span>age<span class="pl-cce">\"</span>:10}<span class="pl-pds">"</span></span>;
@@ -368,59 +376,127 @@ These SDK writer output contains just a carbondata and carbonindex files. No met
} </pre></div>
<h2>
<a id="datatypes-mapping" class="anchor" href="#datatypes-mapping" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Datatypes Mapping</h2>
-<p>Each of SQL data types are mapped into data types of SDK. Following are the mapping:</p>
+<p>Each of SQL data types and Avro Data Types are mapped into data types of SDK. Following are the mapping:</p>
<table>
<thead>
<tr>
<th>SQL DataTypes</th>
+<th>Avro DataTypes</th>
<th>Mapped SDK DataTypes</th>
</tr>
</thead>
<tbody>
<tr>
<td>BOOLEAN</td>
+<td>BOOLEAN</td>
<td>DataTypes.BOOLEAN</td>
</tr>
<tr>
<td>SMALLINT</td>
+<td>-</td>
<td>DataTypes.SHORT</td>
</tr>
<tr>
<td>INTEGER</td>
+<td>INTEGER</td>
<td>DataTypes.INT</td>
</tr>
<tr>
<td>BIGINT</td>
+<td>LONG</td>
<td>DataTypes.LONG</td>
</tr>
<tr>
<td>DOUBLE</td>
+<td>DOUBLE</td>
<td>DataTypes.DOUBLE</td>
</tr>
<tr>
<td>VARCHAR</td>
+<td>-</td>
<td>DataTypes.STRING</td>
</tr>
<tr>
+<td>FLOAT</td>
+<td>FLOAT</td>
+<td>DataTypes.FLOAT</td>
+</tr>
+<tr>
+<td>BYTE</td>
+<td>-</td>
+<td>DataTypes.BYTE</td>
+</tr>
+<tr>
+<td>DATE</td>
<td>DATE</td>
<td>DataTypes.DATE</td>
</tr>
<tr>
<td>TIMESTAMP</td>
+<td>-</td>
<td>DataTypes.TIMESTAMP</td>
</tr>
<tr>
<td>STRING</td>
+<td>STRING</td>
<td>DataTypes.STRING</td>
</tr>
<tr>
<td>DECIMAL</td>
+<td>DECIMAL</td>
<td>DataTypes.createDecimalType(precision, scale)</td>
</tr>
+<tr>
+<td>ARRAY</td>
+<td>ARRAY</td>
+<td>DataTypes.createArrayType(elementType)</td>
+</tr>
+<tr>
+<td>STRUCT</td>
+<td>RECORD</td>
+<td>DataTypes.createStructType(fields)</td>
+</tr>
+<tr>
+<td>-</td>
+<td>ENUM</td>
+<td>DataTypes.STRING</td>
+</tr>
+<tr>
+<td>-</td>
+<td>UNION</td>
+<td>DataTypes.createStructType(types)</td>
+</tr>
+<tr>
+<td>-</td>
+<td>MAP</td>
+<td>DataTypes.createMapType(keyType, valueType)</td>
+</tr>
+<tr>
+<td>-</td>
+<td>TimeMillis</td>
+<td>DataTypes.INT</td>
+</tr>
+<tr>
+<td>-</td>
+<td>TimeMicros</td>
+<td>DataTypes.LONG</td>
+</tr>
+<tr>
+<td>-</td>
+<td>TimestampMillis</td>
+<td>DataTypes.TIMESTAMP</td>
+</tr>
+<tr>
+<td>-</td>
+<td>TimestampMicros</td>
+<td>DataTypes.TIMESTAMP</td>
+</tr>
</tbody>
</table>
-<p><strong>NOTE:</strong>
-Carbon Supports below logical types of AVRO.
+<p><strong>NOTE:</strong></p>
+<ol>
+<li>
+<p>Carbon Supports below logical types of AVRO.
a. Date
The date logical type represents a date within the calendar, with no reference to a particular time zone or time of day.
A date logical type annotates an Avro int, where the int stores the number of days from the unix epoch, 1 January 1970 (ISO calendar).
@@ -429,10 +505,27 @@ The timestamp-millis logical type represents an instant on the global timeline,
A timestamp-millis logical type annotates an Avro long, where the long stores the number of milliseconds from the unix epoch, 1 January 1970 00:00:00.000 UTC.
c. Timestamp (microsecond precision)
The timestamp-micros logical type represents an instant on the global timeline, independent of a particular time zone or calendar, with a precision of one microsecond.
-A timestamp-micros logical type annotates an Avro long, where the long stores the number of microseconds from the unix epoch, 1 January 1970 00:00:00.000000 UTC.</p>
-<pre><code>Currently the values of logical types are not validated by carbon.
-Expect that avro record passed by the user is already validated by avro record generator tools.
-</code></pre>
+A timestamp-micros logical type annotates an Avro long, where the long stores the number of microseconds from the unix epoch, 1 January 1970 00:00:00.000000 UTC.
+d. Decimal
+The decimal logical type represents an arbitrary-precision signed decimal number of the form unscaled � 10-scale.
+A decimal logical type annotates Avro bytes or fixed types. The byte array must contain the two's-complement representation of the unscaled integer value in big-endian byte order. The scale is fixed, and is specified using an attribute.
+e. Time (millisecond precision)
+The time-millis logical type represents a time of day, with no reference to a particular calendar, time zone or date, with a precision of one millisecond.
+A time-millis logical type annotates an Avro int, where the int stores the number of milliseconds after midnight, 00:00:00.000.
+f. Time (microsecond precision)
+The time-micros logical type represents a time of day, with no reference to a particular calendar, time zone or date, with a precision of one microsecond.
+A time-micros logical type annotates an Avro long, where the long stores the number of microseconds after midnight, 00:00:00.000000.</p>
+<p>Currently the values of logical types are not validated by carbon.
+Expect that avro record passed by the user is already validated by avro record generator tools.</p>
+</li>
+<li>
+<p>If the string data is more than 32K in length, use withTableProperties() with "long_string_columns" property
+or directly use DataTypes.VARCHAR if it is carbon schema.</p>
+</li>
+<li>
+<p>Avro Bytes, Fixed and Duration data types are not yet supported.</p>
+</li>
+</ol>
<h2>
<a id="run-sql-on-files-directly" class="anchor" href="#run-sql-on-files-directly" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Run SQL on files directly</h2>
<p>Instead of creating table and query it, you can also query that file directly with SQL.</p>
@@ -454,18 +547,6 @@ Expect that avro record passed by the user is already validated by avro record g
public CarbonWriterBuilder outputPath(String path);
</code></pre>
<pre><code>/**
-* If set false, writes the carbondata and carbonindex files in a flat folder structure
-* @param isTransactionalTable is a boolelan value
-* if set to false, then writes the carbondata and carbonindex files
-* in a flat folder structure.
-* if set to true, then writes the carbondata and carbonindex files
-* in segment folder structure..
-* By default set to false.
-* @return updated CarbonWriterBuilder
-*/
-public CarbonWriterBuilder isTransactionalTable(boolean isTransactionalTable);
-</code></pre>
-<pre><code>/**
* to set the timestamp in the carbondata and carbonindex index files
* @param UUID is a timestamp to be used in the carbondata and carbonindex index files.
* By default set to zero.
@@ -511,14 +592,6 @@ public CarbonWriterBuilder localDictionaryThreshold(int localDictionaryThreshold
public CarbonWriterBuilder sortBy(String[] sortColumns);
</code></pre>
<pre><code>/**
-* If set, create a schema file in metadata folder.
-* @param persist is a boolean value, If set to true, creates a schema file in metadata folder.
-* By default set to false. will not create metadata folder
-* @return updated CarbonWriterBuilder
-*/
-public CarbonWriterBuilder persistSchemaFile(boolean persist);
-</code></pre>
-<pre><code>/**
* sets the taskNo for the writer. SDKs concurrently running
* will set taskNo in order to avoid conflicts in file's name during write.
* @param taskNo is the TaskNo user wants to specify.
@@ -540,7 +613,7 @@ public CarbonWriterBuilder taskNo(long taskNo);
* g. complex_delimiter_level_2 -- value to Split the nested complexTypeData
* h. quotechar
* i. escapechar
-*
+*
* Default values are as follows.
*
* a. bad_records_logger_enable -- "false"
@@ -558,84 +631,76 @@ public CarbonWriterBuilder taskNo(long taskNo);
public CarbonWriterBuilder withLoadOptions(Map<String, String> options);
</code></pre>
<pre><code>/**
- * To support the table properties for sdk writer
- *
- * @param options key,value pair of create table properties.
- * supported keys values are
- * a. blocksize -- [1-2048] values in MB. Default value is 1024
- * b. blockletsize -- values in MB. Default value is 64 MB
- * c. localDictionaryThreshold -- positive value, default is 10000
- * d. enableLocalDictionary -- true / false. Default is false
- * e. sortcolumns -- comma separated column. "c1,c2". Default all dimensions are sorted.
- *
- * @return updated CarbonWriterBuilder
- */
+* To support the table properties for sdk writer
+*
+* @param options key,value pair of create table properties.
+* supported keys values are
+* a. table_blocksize -- [1-2048] values in MB. Default value is 1024
+* b. table_blocklet_size -- values in MB. Default value is 64 MB
+* c. local_dictionary_threshold -- positive value, default is 10000
+* d. local_dictionary_enable -- true / false. Default is false
+* e. sort_columns -- comma separated column. "c1,c2". Default all dimensions are sorted.
+ If empty string "" is passed. No columns are sorted
+* j. sort_scope -- "local_sort", "no_sort", "batch_sort". default value is "local_sort"
+* k. long_string_columns -- comma separated string columns which are more than 32k length.
+* default value is null.
+*
+* @return updated CarbonWriterBuilder
+*/
public CarbonWriterBuilder withTableProperties(Map<String, String> options);
</code></pre>
<pre><code>/**
-* this writer is not thread safe, use buildThreadSafeWriterForCSVInput in multi thread environment
-* Build a {@link CarbonWriter}, which accepts row in CSV format object
-* @param schema carbon Schema object {org.apache.carbondata.sdk.file.Schema}
-* @return CSVCarbonWriter
-* @throws IOException
-* @throws InvalidLoadOptionException
+* To make sdk writer thread safe.
+*
+* @param numOfThreads should number of threads in which writer is called in multi-thread scenario
+* default sdk writer is not thread safe.
+* can use one writer instance in one thread only.
+* @return updated CarbonWriterBuilder
*/
-public CarbonWriter buildWriterForCSVInput(org.apache.carbondata.sdk.file.Schema schema) throws IOException, InvalidLoadOptionException;
+public CarbonWriterBuilder withThreadSafe(short numOfThreads);
</code></pre>
<pre><code>/**
-* Can use this writer in multi-thread instance.
-* Build a {@link CarbonWriter}, which accepts row in CSV format
-* @param schema carbon Schema object {org.apache.carbondata.sdk.file.Schema}
-* @param numOfThreads number of threads() in which .write will be called.
-* @return CSVCarbonWriter
-* @throws IOException
-* @throws InvalidLoadOptionException
+* To support hadoop configuration
+*
+* @param conf hadoop configuration support, can set s3a AK,SK,end point and other conf with this
+* @return updated CarbonWriterBuilder
*/
-public CarbonWriter buildThreadSafeWriterForCSVInput(Schema schema, short numOfThreads)
- throws IOException, InvalidLoadOptionException;
+public CarbonWriterBuilder withHadoopConf(Configuration conf)
</code></pre>
<pre><code>/**
-* this writer is not thread safe, use buildThreadSafeWriterForAvroInput in multi thread environment
-* Build a {@link CarbonWriter}, which accepts Avro format object
-* @param avroSchema avro Schema object {org.apache.avro.Schema}
-* @return AvroCarbonWriter
-* @throws IOException
-* @throws InvalidLoadOptionException
+* to build a {@link CarbonWriter}, which accepts row in CSV format
+*
+* @param schema carbon Schema object {org.apache.carbondata.sdk.file.Schema}
+* @return CarbonWriterBuilder
*/
-public CarbonWriter buildWriterForAvroInput(org.apache.avro.Schema schema) throws IOException, InvalidLoadOptionException;
+public CarbonWriterBuilder withCsvInput(Schema schema);
</code></pre>
<pre><code>/**
-* Can use this writer in multi-thread instance.
-* Build a {@link CarbonWriter}, which accepts Avro object
+* to build a {@link CarbonWriter}, which accepts Avro object
+*
* @param avroSchema avro Schema object {org.apache.avro.Schema}
-* @param numOfThreads number of threads() in which .write will be called.
-* @return AvroCarbonWriter
-* @throws IOException
-* @throws InvalidLoadOptionException
+* @return CarbonWriterBuilder
*/
-public CarbonWriter buildThreadSafeWriterForAvroInput(org.apache.avro.Schema avroSchema, short numOfThreads)
- throws IOException, InvalidLoadOptionException
+public CarbonWriterBuilder withAvroInput(org.apache.avro.Schema avroSchema);
</code></pre>
<pre><code>/**
-* this writer is not thread safe, use buildThreadSafeWriterForJsonInput in multi thread environment
-* Build a {@link CarbonWriter}, which accepts Json object
+* to build a {@link CarbonWriter}, which accepts Json object
+*
* @param carbonSchema carbon Schema object
-* @return JsonCarbonWriter
-* @throws IOException
-* @throws InvalidLoadOptionException
+* @return CarbonWriterBuilder
*/
-public JsonCarbonWriter buildWriterForJsonInput(Schema carbonSchema);
+public CarbonWriterBuilder withJsonInput(Schema carbonSchema);
</code></pre>
<pre><code>/**
-* Can use this writer in multi-thread instance.
-* Build a {@link CarbonWriter}, which accepts Json object
-* @param carbonSchema carbon Schema object
-* @param numOfThreads number of threads() in which .write will be called.
-* @return JsonCarbonWriter
+* Build a {@link CarbonWriter}
+* This writer is not thread safe,
+* use withThreadSafe() configuration in multi thread environment
+*
+* @return CarbonWriter {AvroCarbonWriter/CSVCarbonWriter/JsonCarbonWriter based on Input Type }
* @throws IOException
* @throws InvalidLoadOptionException
*/
-public JsonCarbonWriter buildThreadSafeWriterForJsonInput(Schema carbonSchema, short numOfThreads)
+public CarbonWriter build() throws IOException, InvalidLoadOptionException;
</code></pre>
<h3>
<a id="class-orgapachecarbondatasdkfilecarbonwriter" class="anchor" href="#class-orgapachecarbondatasdkfilecarbonwriter" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Class org.apache.carbondata.sdk.file.CarbonWriter</h3>
@@ -645,7 +710,6 @@ public JsonCarbonWriter buildThreadSafeWriterForJsonInput(Schema carbonSchema, s
* which is one row of data.
* If CSVCarbonWriter, object is of type String[], which is one row of data
* If JsonCarbonWriter, object is of type String, which is one row of json
-* Note: This API is not thread safe if writer is not built with number of threads argument.
* @param object
* @throws IOException
*/
@@ -793,17 +857,6 @@ External client can make use of this reader to read CarbonData files without Car
*/
public CarbonReaderBuilder projection(String[] projectionColumnNames);
</code></pre>
-<pre><code> /**
- * Configure the transactional status of table
- * If set to false, then reads the carbondata and carbonindex files from a flat folder structure.
- * If set to true, then reads the carbondata and carbonindex files from segment folder structure.
- * Default value is false
- *
- * @param isTransactionalTable whether is transactional table or not
- * @return CarbonReaderBuilder object
- */
- public CarbonReaderBuilder isTransactionalTable(boolean isTransactionalTable);
-</code></pre>
<pre><code> /**
* Configure the filter expression for carbon reader
*
@@ -812,56 +865,13 @@ External client can make use of this reader to read CarbonData files without Car
*/
public CarbonReaderBuilder filter(Expression filterExpression);
</code></pre>
-<pre><code> /**
- * Set the access key for S3
- *
- * @param key the string of access key for different S3 type,like: fs.s3a.access.key
- * @param value the value of access key
- * @return CarbonWriterBuilder
- */
- public CarbonReaderBuilder setAccessKey(String key, String value);
-</code></pre>
-<pre><code> /**
- * Set the access key for S3.
- *
- * @param value the value of access key
- * @return CarbonWriterBuilder object
- */
- public CarbonReaderBuilder setAccessKey(String value);
-</code></pre>
-<pre><code> /**
- * Set the secret key for S3
- *
- * @param key the string of secret key for different S3 type,like: fs.s3a.secret.key
- * @param value the value of secret key
- * @return CarbonWriterBuilder object
- */
- public CarbonReaderBuilder setSecretKey(String key, String value);
-</code></pre>
-<pre><code> /**
- * Set the secret key for S3
- *
- * @param value the value of secret key
- * @return CarbonWriterBuilder object
- */
- public CarbonReaderBuilder setSecretKey(String value);
-</code></pre>
-<pre><code> /**
- * Set the endpoint for S3
- *
- * @param key the string of endpoint for different S3 type,like: fs.s3a.endpoint
- * @param value the value of endpoint
- * @return CarbonWriterBuilder object
- */
- public CarbonReaderBuilder setEndPoint(String key, String value);
-</code></pre>
-<pre><code> /**
- * Set the endpoint for S3
- *
- * @param value the value of endpoint
- * @return CarbonWriterBuilder object
- */
- public CarbonReaderBuilder setEndPoint(String value);
+<pre><code>/**
+ * To support hadoop configuration
+ *
+ * @param conf hadoop configuration support, can set s3a AK,SK,end point and other conf with this
+ * @return updated CarbonReaderBuilder
+ */
+ public CarbonReaderBuilder withHadoopConf(Configuration conf);
</code></pre>
<pre><code> /**
* Build CarbonReader
@@ -992,8 +1002,15 @@ public String getProperty(String key, String defaultValue);
</code></pre>
<p>Reference : <a href="./configuration-parameters.html">list of carbon properties</a></p>
<script>
-// Show selected style on nav item
-$(function() { $('.b-nav__api').addClass('selected'); });
+$(function() {
+ // Show selected style on nav item
+ $('.b-nav__api').addClass('selected');
+
+ if (!$('.b-nav__api').parent().hasClass('nav__item__with__subs--expanded')) {
+ // Display api subnav items
+ $('.b-nav__api').parent().toggleClass('nav__item__with__subs--expanded');
+ }
+});
</script></div>
</div>
</div>
http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6ad7599a/content/sdk-writer-guide.html
----------------------------------------------------------------------
diff --git a/content/sdk-writer-guide.html b/content/sdk-writer-guide.html
deleted file mode 100644
index 36bb9ad..0000000
--- a/content/sdk-writer-guide.html
+++ /dev/null
@@ -1,549 +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.4.0/"
- target="_blank">Apache CarbonData 1.4.0</a></li>
- <li>
- <a href="https://dist.apache.org/repos/dist/release/carbondata/1.3.1/"
- target="_blank">Apache CarbonData 1.3.1</a></li>
- <li>
- <a href="https://dist.apache.org/repos/dist/release/carbondata/1.3.0/"
- target="_blank">Apache CarbonData 1.3.0</a></li>
- <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="sdk-writer-guide" class="anchor" href="#sdk-writer-guide" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>SDK Writer Guide</h1>
-<p>In the carbon jars package, there exist a carbondata-store-sdk-x.x.x-SNAPSHOT.jar.
-This SDK writer, writes carbondata file and carbonindex file at a given path.
-External client can make use of this writer to convert other format data or live data to create carbondata and index files.
-These SDK writer output contains just a carbondata and carbonindex files. No metadata folder will be present.</p>
-<h2>
-<a id="quick-example" class="anchor" href="#quick-example" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Quick example</h2>
-<h3>
-<a id="example-with-csv-format" class="anchor" href="#example-with-csv-format" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Example with csv format</h3>
-<div class="highlight highlight-source-java"><pre> <span class="pl-k">import</span> <span class="pl-smi">java.io.IOException</span>;
-
- <span class="pl-k">import</span> <span class="pl-smi">org.apache.carbondata.common.exceptions.sql.InvalidLoadOptionException</span>;
- <span class="pl-k">import</span> <span class="pl-smi">org.apache.carbondata.core.metadata.datatype.DataTypes</span>;
- <span class="pl-k">import</span> <span class="pl-smi">org.apache.carbondata.sdk.file.CarbonWriter</span>;
- <span class="pl-k">import</span> <span class="pl-smi">org.apache.carbondata.sdk.file.CarbonWriterBuilder</span>;
- <span class="pl-k">import</span> <span class="pl-smi">org.apache.carbondata.sdk.file.Field</span>;
- <span class="pl-k">import</span> <span class="pl-smi">org.apache.carbondata.sdk.file.Schema</span>;
-
- <span class="pl-k">public</span> <span class="pl-k">class</span> <span class="pl-en">TestSdk</span> {
-
- <span class="pl-k">public</span> <span class="pl-k">static</span> <span class="pl-k">void</span> <span class="pl-en">main</span>(<span class="pl-k">String</span>[] <span class="pl-v">args</span>) <span class="pl-k">throws</span> <span class="pl-smi">IOException</span>, <span class="pl-smi">InvalidLoadOptionException</span> {
- testSdkWriter();
- }
-
- <span class="pl-k">public</span> <span class="pl-k">static</span> <span class="pl-k">void</span> <span class="pl-en">testSdkWriter</span>() <span class="pl-k">throws</span> <span class="pl-smi">IOException</span>, <span class="pl-smi">InvalidLoadOptionException</span> {
- <span class="pl-smi">String</span> path <span class="pl-k">=</span> <span class="pl-s"><span class="pl-pds">"</span>/home/root1/Documents/ab/temp<span class="pl-pds">"</span></span>;
-
- <span class="pl-k">Field</span>[] fields <span class="pl-k">=</span> <span class="pl-k">new</span> <span class="pl-smi">Field</span>[<span class="pl-c1">2</span>];
- fields[<span class="pl-c1">0</span>] <span class="pl-k">=</span> <span class="pl-k">new</span> <span class="pl-smi">Field</span>(<span class="pl-s"><span class="pl-pds">"</span>name<span class="pl-pds">"</span></span>, <span class="pl-smi">DataTypes</span><span class="pl-c1"><span class="pl-k">.</span>STRING</span>);
- fields[<span class="pl-c1">1</span>] <span class="pl-k">=</span> <span class="pl-k">new</span> <span class="pl-smi">Field</span>(<span class="pl-s"><span class="pl-pds">"</span>age<span class="pl-pds">"</span></span>, <span class="pl-smi">DataTypes</span><span class="pl-c1"><span class="pl-k">.</span>INT</span>);
-
- <span class="pl-smi">Schema</span> schema <span class="pl-k">=</span> <span class="pl-k">new</span> <span class="pl-smi">Schema</span>(fields);
-
- <span class="pl-smi">CarbonWriterBuilder</span> builder <span class="pl-k">=</span> <span class="pl-smi">CarbonWriter</span><span class="pl-k">.</span>builder()<span class="pl-k">.</span>withSchema(schema)<span class="pl-k">.</span>outputPath(path);
-
- <span class="pl-smi">CarbonWriter</span> writer <span class="pl-k">=</span> builder<span class="pl-k">.</span>buildWriterForCSVInput();
-
- <span class="pl-k">int</span> rows <span class="pl-k">=</span> <span class="pl-c1">5</span>;
- <span class="pl-k">for</span> (<span class="pl-k">int</span> i <span class="pl-k">=</span> <span class="pl-c1">0</span>; i <span class="pl-k"><</span> rows; i<span class="pl-k">++</span>) {
- writer<span class="pl-k">.</span>write(<span class="pl-k">new</span> <span class="pl-smi">String</span>[] { <span class="pl-s"><span class="pl-pds">"</span>robot<span class="pl-pds">"</span></span> <span class="pl-k">+</span> (i <span class="pl-k">%</span> <span class="pl-c1">10</span>), <span class="pl-smi">String</span><span class="pl-k">.</span>valueOf(i) });
- }
- writer<span class="pl-k">.</span>close();
- }
- }</pre></div>
-<h3>
-<a id="example-with-avro-format" class="anchor" href="#example-with-avro-format" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Example with Avro format</h3>
-<div class="highlight highlight-source-java"><pre><span class="pl-k">import</span> <span class="pl-smi">java.io.IOException</span>;
-
-<span class="pl-k">import</span> <span class="pl-smi">org.apache.carbondata.common.exceptions.sql.InvalidLoadOptionException</span>;
-<span class="pl-k">import</span> <span class="pl-smi">org.apache.carbondata.core.metadata.datatype.DataTypes</span>;
-<span class="pl-k">import</span> <span class="pl-smi">org.apache.carbondata.sdk.file.AvroCarbonWriter</span>;
-<span class="pl-k">import</span> <span class="pl-smi">org.apache.carbondata.sdk.file.CarbonWriter</span>;
-<span class="pl-k">import</span> <span class="pl-smi">org.apache.carbondata.sdk.file.Field</span>;
-
-<span class="pl-k">import</span> <span class="pl-smi">org.apache.avro.generic.GenericData</span>;
-<span class="pl-k">import</span> <span class="pl-smi">org.apache.commons.lang.CharEncoding</span>;
-
-<span class="pl-k">import</span> <span class="pl-smi">tech.allegro.schema.json2avro.converter.JsonAvroConverter</span>;
-
-<span class="pl-k">public</span> <span class="pl-k">class</span> <span class="pl-en">TestSdkAvro</span> {
-
- <span class="pl-k">public</span> <span class="pl-k">static</span> <span class="pl-k">void</span> <span class="pl-en">main</span>(<span class="pl-k">String</span>[] <span class="pl-v">args</span>) <span class="pl-k">throws</span> <span class="pl-smi">IOException</span>, <span class="pl-smi">InvalidLoadOptionException</span> {
- testSdkWriter();
- }
-
-
- <span class="pl-k">public</span> <span class="pl-k">static</span> <span class="pl-k">void</span> <span class="pl-en">testSdkWriter</span>() <span class="pl-k">throws</span> <span class="pl-smi">IOException</span>, <span class="pl-smi">InvalidLoadOptionException</span> {
- <span class="pl-smi">String</span> path <span class="pl-k">=</span> <span class="pl-s"><span class="pl-pds">"</span>./AvroCarbonWriterSuiteWriteFiles<span class="pl-pds">"</span></span>;
- <span class="pl-c"><span class="pl-c">//</span> Avro schema</span>
- <span class="pl-smi">String</span> avroSchema <span class="pl-k">=</span>
- <span class="pl-s"><span class="pl-pds">"</span>{<span class="pl-pds">"</span></span> <span class="pl-k">+</span>
- <span class="pl-s"><span class="pl-pds">"</span> <span class="pl-cce">\"</span>type<span class="pl-cce">\"</span> : <span class="pl-cce">\"</span>record<span class="pl-cce">\"</span>,<span class="pl-pds">"</span></span> <span class="pl-k">+</span>
- <span class="pl-s"><span class="pl-pds">"</span> <span class="pl-cce">\"</span>name<span class="pl-cce">\"</span> : <span class="pl-cce">\"</span>Acme<span class="pl-cce">\"</span>,<span class="pl-pds">"</span></span> <span class="pl-k">+</span>
- <span class="pl-s"><span class="pl-pds">"</span> <span class="pl-cce">\"</span>fields<span class="pl-cce">\"</span> : [<span class="pl-pds">"</span></span>
- <span class="pl-k">+</span> <span class="pl-s"><span class="pl-pds">"</span>{ <span class="pl-cce">\"</span>name<span class="pl-cce">\"</span> : <span class="pl-cce">\"</span>fname<span class="pl-cce">\"</span>, <span class="pl-cce">\"</span>type<span class="pl-cce">\"</span> : <span class="pl-cce">\"</span>string<span class="pl-cce">\"</span> },<span class="pl-pds">"</span></span>
- <span class="pl-k">+</span> <span class="pl-s"><span class="pl-pds">"</span>{ <span class="pl-cce">\"</span>name<span class="pl-cce">\"</span> : <span class="pl-cce">\"</span>age<span class="pl-cce">\"</span>, <span class="pl-cce">\"</span>type<span class="pl-cce">\"</span> : <span class="pl-cce">\"</span>int<span class="pl-cce">\"</span> }]<span class="pl-pds">"</span></span> <span class="pl-k">+</span>
- <span class="pl-s"><span class="pl-pds">"</span>}<span class="pl-pds">"</span></span>;
-
- <span class="pl-smi">String</span> json <span class="pl-k">=</span> <span class="pl-s"><span class="pl-pds">"</span>{<span class="pl-cce">\"</span>fname<span class="pl-cce">\"</span>:<span class="pl-cce">\"</span>bob<span class="pl-cce">\"</span>, <span class="pl-cce">\"</span>age<span class="pl-cce">\"</span>:10}<span class="pl-pds">"</span></span>;
-
- <span class="pl-c"><span class="pl-c">//</span> conversion to GenericData.Record</span>
- <span class="pl-smi">JsonAvroConverter</span> converter <span class="pl-k">=</span> <span class="pl-k">new</span> <span class="pl-smi">JsonAvroConverter</span>();
- <span class="pl-smi">GenericData</span><span class="pl-k">.</span><span class="pl-smi">Record</span> record <span class="pl-k">=</span> converter<span class="pl-k">.</span>convertToGenericDataRecord(
- json<span class="pl-k">.</span>getBytes(<span class="pl-smi">CharEncoding</span><span class="pl-c1"><span class="pl-k">.</span>UTF_8</span>), <span class="pl-k">new</span> <span class="pl-smi">org.apache.avro<span class="pl-k">.</span>Schema</span>.<span class="pl-smi">Parser</span>()<span class="pl-k">.</span>parse(avroSchema));
-
- <span class="pl-c"><span class="pl-c">//</span> prepare carbon schema from avro schema </span>
- <span class="pl-smi">org.apache.carbondata.sdk.file<span class="pl-k">.</span>Schema</span> carbonSchema <span class="pl-k">=</span>
- <span class="pl-smi">AvroCarbonWriter</span><span class="pl-k">.</span>getCarbonSchemaFromAvroSchema(avroSchema);
-
- <span class="pl-k">try</span> {
- <span class="pl-smi">CarbonWriter</span> writer <span class="pl-k">=</span> <span class="pl-smi">CarbonWriter</span><span class="pl-k">.</span>builder()
- .withSchema(carbonSchema)
- .outputPath(path)
- .buildWriterForAvroInput();
-
- <span class="pl-k">for</span> (<span class="pl-k">int</span> i <span class="pl-k">=</span> <span class="pl-c1">0</span>; i <span class="pl-k"><</span> <span class="pl-c1">100</span>; i<span class="pl-k">++</span>) {
- writer<span class="pl-k">.</span>write(record);
- }
- writer<span class="pl-k">.</span>close();
- } <span class="pl-k">catch</span> (<span class="pl-smi">Exception</span> e) {
- e<span class="pl-k">.</span>printStackTrace();
- }
- }
-}</pre></div>
-<h2>
-<a id="datatypes-mapping" class="anchor" href="#datatypes-mapping" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Datatypes Mapping</h2>
-<p>Each of SQL data types are mapped into data types of SDK. Following are the mapping:</p>
-<table>
-<thead>
-<tr>
-<th>SQL DataTypes</th>
-<th>Mapped SDK DataTypes</th>
-</tr>
-</thead>
-<tbody>
-<tr>
-<td>BOOLEAN</td>
-<td>DataTypes.BOOLEAN</td>
-</tr>
-<tr>
-<td>SMALLINT</td>
-<td>DataTypes.SHORT</td>
-</tr>
-<tr>
-<td>INTEGER</td>
-<td>DataTypes.INT</td>
-</tr>
-<tr>
-<td>BIGINT</td>
-<td>DataTypes.LONG</td>
-</tr>
-<tr>
-<td>DOUBLE</td>
-<td>DataTypes.DOUBLE</td>
-</tr>
-<tr>
-<td>VARCHAR</td>
-<td>DataTypes.STRING</td>
-</tr>
-<tr>
-<td>DATE</td>
-<td>DataTypes.DATE</td>
-</tr>
-<tr>
-<td>TIMESTAMP</td>
-<td>DataTypes.TIMESTAMP</td>
-</tr>
-<tr>
-<td>STRING</td>
-<td>DataTypes.STRING</td>
-</tr>
-<tr>
-<td>DECIMAL</td>
-<td>DataTypes.createDecimalType(precision, scale)</td>
-</tr>
-</tbody>
-</table>
-<h2>
-<a id="api-list" class="anchor" href="#api-list" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>API List</h2>
-<h3>
-<a id="class-orgapachecarbondatasdkfilecarbonwriterbuilder" class="anchor" href="#class-orgapachecarbondatasdkfilecarbonwriterbuilder" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Class org.apache.carbondata.sdk.file.CarbonWriterBuilder</h3>
-<pre><code>/**
-* prepares the builder with the schema provided
-* @param schema is instance of Schema
-* This method must be called when building CarbonWriterBuilder
-* @return updated CarbonWriterBuilder
-*/
-public CarbonWriterBuilder withSchema(Schema schema);
-</code></pre>
-<pre><code>/**
-* Sets the output path of the writer builder
-* @param path is the absolute path where output files are written
-* This method must be called when building CarbonWriterBuilder
-* @return updated CarbonWriterBuilder
-*/
-public CarbonWriterBuilder outputPath(String path);
-</code></pre>
-<pre><code>/**
-* If set false, writes the carbondata and carbonindex files in a flat folder structure
-* @param isTransactionalTable is a boolelan value
-* if set to false, then writes the carbondata and carbonindex files
-* in a flat folder structure.
-* if set to true, then writes the carbondata and carbonindex files
-* in segment folder structure..
-* By default set to false.
-* @return updated CarbonWriterBuilder
-*/
-public CarbonWriterBuilder isTransactionalTable(boolean isTransactionalTable);
-</code></pre>
-<pre><code>/**
-* to set the timestamp in the carbondata and carbonindex index files
-* @param UUID is a timestamp to be used in the carbondata and carbonindex index files.
-* By default set to zero.
-* @return updated CarbonWriterBuilder
-*/
-public CarbonWriterBuilder uniqueIdentifier(long UUID);
-</code></pre>
-<pre><code>/**
-* To set the carbondata file size in MB between 1MB-2048MB
-* @param blockSize is size in MB between 1MB to 2048 MB
-* default value is 1024 MB
-* @return updated CarbonWriterBuilder
-*/
-public CarbonWriterBuilder withBlockSize(int blockSize);
-</code></pre>
-<pre><code>/**
-* To set the blocklet size of carbondata file
-* @param blockletSize is blocklet size in MB
-* default value is 64 MB
-* @return updated CarbonWriterBuilder
-*/
-public CarbonWriterBuilder withBlockletSize(int blockletSize);
-</code></pre>
-<pre><code>/**
-* sets the list of columns that needs to be in sorted order
-* @param sortColumns is a string array of columns that needs to be sorted.
-* If it is null or by default all dimensions are selected for sorting
-* If it is empty array, no columns are sorted
-* @return updated CarbonWriterBuilder
-*/
-public CarbonWriterBuilder sortBy(String[] sortColumns);
-</code></pre>
-<pre><code>/**
-* If set, create a schema file in metadata folder.
-* @param persist is a boolean value, If set to true, creates a schema file in metadata folder.
-* By default set to false. will not create metadata folder
-* @return updated CarbonWriterBuilder
-*/
-public CarbonWriterBuilder persistSchemaFile(boolean persist);
-</code></pre>
-<pre><code>/**
-* sets the taskNo for the writer. SDKs concurrently running
-* will set taskNo in order to avoid conflicts in file's name during write.
-* @param taskNo is the TaskNo user wants to specify.
-* by default it is system time in nano seconds.
-* @return updated CarbonWriterBuilder
-*/
-public CarbonWriterBuilder taskNo(String taskNo);
-</code></pre>
-<pre><code>/**
-* To support the load options for sdk writer
-* @param options key,value pair of load options.
-* supported keys values are
-* a. bad_records_logger_enable -- true (write into separate logs), false
-* b. bad_records_action -- FAIL, FORCE, IGNORE, REDIRECT
-* c. bad_record_path -- path
-* d. dateformat -- same as JAVA SimpleDateFormat
-* e. timestampformat -- same as JAVA SimpleDateFormat
-* f. complex_delimiter_level_1 -- value to Split the complexTypeData
-* g. complex_delimiter_level_2 -- value to Split the nested complexTypeData
-* h. quotechar
-* i. escapechar
-*
-* Default values are as follows.
-*
-* a. bad_records_logger_enable -- "false"
-* b. bad_records_action -- "FAIL"
-* c. bad_record_path -- ""
-* d. dateformat -- "" , uses from carbon.properties file
-* e. timestampformat -- "", uses from carbon.properties file
-* f. complex_delimiter_level_1 -- "$"
-* g. complex_delimiter_level_2 -- ":"
-* h. quotechar -- "\""
-* i. escapechar -- "\\"
-*
-* @return updated CarbonWriterBuilder
-*/
-public CarbonWriterBuilder withLoadOptions(Map<String, String> options);
-</code></pre>
-<pre><code>/**
-* Build a {@link CarbonWriter}, which accepts row in CSV format object
-* @return CSVCarbonWriter
-* @throws IOException
-* @throws InvalidLoadOptionException
-*/
-public CarbonWriter buildWriterForCSVInput() throws IOException, InvalidLoadOptionException;
-</code></pre>
-<pre><code>/**
-* Build a {@link CarbonWriter}, which accepts Avro format object
-* @return AvroCarbonWriter
-* @throws IOException
-* @throws InvalidLoadOptionException
-*/
-public CarbonWriter buildWriterForAvroInput() throws IOException, InvalidLoadOptionException;
-</code></pre>
-<h3>
-<a id="class-orgapachecarbondatasdkfilecarbonwriter" class="anchor" href="#class-orgapachecarbondatasdkfilecarbonwriter" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Class org.apache.carbondata.sdk.file.CarbonWriter</h3>
-<pre><code>/**
-* Write an object to the file, the format of the object depends on the implementation
-* If AvroCarbonWriter, object is of type org.apache.avro.generic.GenericData.Record
-* If CSVCarbonWriter, object is of type String[]
-* Note: This API is not thread safe
-* @param object
-* @throws IOException
-*/
-public abstract void write(Object object) throws IOException;
-</code></pre>
-<pre><code>/**
-* Flush and close the writer
-*/
-public abstract void close() throws IOException;
-</code></pre>
-<pre><code>/**
-* Create a {@link CarbonWriterBuilder} to build a {@link CarbonWriter}
-*/
-public static CarbonWriterBuilder builder() {
-return new CarbonWriterBuilder();
-}
-</code></pre>
-<h3>
-<a id="class-orgapachecarbondatasdkfilefield" class="anchor" href="#class-orgapachecarbondatasdkfilefield" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Class org.apache.carbondata.sdk.file.Field</h3>
-<pre><code>/**
-* Field Constructor
-* @param name name of the field
-* @param type datatype of field, specified in strings.
-*/
-public Field(String name, String type);
-</code></pre>
-<pre><code>/**
-* Field constructor
-* @param name name of the field
-* @param type datatype of the field of class DataType
-*/
-public Field(String name, DataType type);
-</code></pre>
-<h3>
-<a id="class-orgapachecarbondatasdkfileschema" class="anchor" href="#class-orgapachecarbondatasdkfileschema" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Class org.apache.carbondata.sdk.file.Schema</h3>
-<pre><code>/**
-* construct a schema with fields
-* @param fields
-*/
-public Schema(Field[] fields);
-</code></pre>
-<pre><code>/**
-* Create a Schema using JSON string, for example:
-* [
-* {"name":"string"},
-* {"age":"int"}
-* ]
-* @param json specified as string
-* @return Schema
-*/
-public static Schema parseJson(String json);
-</code></pre>
-<h3>
-<a id="class-orgapachecarbondatasdkfileavrocarbonwriter" class="anchor" href="#class-orgapachecarbondatasdkfileavrocarbonwriter" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Class org.apache.carbondata.sdk.file.AvroCarbonWriter</h3>
-<pre><code>/**
-* converts avro schema to carbon schema, required by carbonWriter
-*
-* @param avroSchemaString json formatted avro schema as string
-* @return carbon sdk schema
-*/
-public static org.apache.carbondata.sdk.file.Schema getCarbonSchemaFromAvroSchema(String avroSchemaString);
-</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/security.html
----------------------------------------------------------------------
diff --git a/content/security.html b/content/security.html
index 9168fa3..1699aed 100644
--- a/content/security.html
+++ b/content/security.html
@@ -61,7 +61,7 @@
target="_blank">Release Archive</a></li>
</ul>
</li>
- <li><a href="mainpage.html" class="">Documentation</a></li>
+ <li><a href="documentation.html" class="">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>
http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6ad7599a/content/segment-management-on-carbondata.html
----------------------------------------------------------------------
diff --git a/content/segment-management-on-carbondata.html b/content/segment-management-on-carbondata.html
index 1e6f61d..1d70f24 100644
--- a/content/segment-management-on-carbondata.html
+++ b/content/segment-management-on-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>
http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6ad7599a/content/streaming-guide.html
----------------------------------------------------------------------
diff --git a/content/streaming-guide.html b/content/streaming-guide.html
index 86f0385..e82b84a 100644
--- a/content/streaming-guide.html
+++ b/content/streaming-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>
@@ -360,7 +368,7 @@ streaming table using following DDL.</p>
<p>At the begin of streaming ingestion, the system will try to acquire the table level lock of streaming.lock file. If the system isn't able to acquire the lock of this table, it will throw an InterruptedException.</p>
<h2>
<a id="create-streaming-segment" class="anchor" href="#create-streaming-segment" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Create streaming segment</h2>
-<p>The input data of streaming will be ingested into a segment of the CarbonData table, the status of this segment is streaming. CarbonData call it a streaming segment. The "tablestatus" file will record the segment status and data size. The user can use ?SHOW SEGMENTS FOR TABLE tableName? to check segment status.</p>
+<p>The streaming data will be ingested into a separate segment of carbondata table, this segment is termed as streaming segment. The status of this segment will be recorded as "streaming" in "tablestatus" file along with its data size. You can use "SHOW SEGMENTS FOR TABLE tableName" to check segment status.</p>
<p>After the streaming segment reaches the max size, CarbonData will change the segment status to "streaming finish" from "streaming", and create new "streaming" segment to continue to ingest streaming data.</p>
<table>
<thead>
@@ -533,8 +541,9 @@ streaming table using following DDL.</p>
| register TIMESTAMP,
| updated TIMESTAMP
|)
- |STORED BY carbondata
+ |STORED AS carbondata
|TBLPROPERTIES (
+ | 'streaming'='source',
| 'format'='csv',
| 'path'='$csvDataDir'
|)
@@ -553,7 +562,7 @@ streaming table using following DDL.</p>
| register TIMESTAMP,
| updated TIMESTAMP
|)
- |STORED BY carbondata
+ |STORED AS carbondata
|TBLPROPERTIES (
| 'streaming'='true'
|)
@@ -576,7 +585,7 @@ streaming table using following DDL.</p>
sql("SHOW STREAMS [ON TABLE tableName]")
</code></pre>
<p>In above example, two table is created: source and sink. The <code>source</code> table's format is <code>csv</code> and <code>sink</code> table format is <code>carbon</code>. Then a streaming job is created to stream data from source table to sink table.</p>
-<p>These two tables are normal carbon table, they can be queried independently.</p>
+<p>These two tables are normal carbon tables, they can be queried independently.</p>
<h3>
<a id="streaming-job-management" class="anchor" href="#streaming-job-management" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Streaming Job Management</h3>
<p>As above example shown:</p>
@@ -601,18 +610,22 @@ streaming table using following DDL.</p>
name STRING,
age <span class="pl-k">INT</span>
)
-STORED BY carbondata
+STORED <span class="pl-k">AS</span> carbondata
TBLPROPERTIES(
- <span class="pl-s"><span class="pl-pds">'</span>format<span class="pl-pds">'</span></span><span class="pl-k">=</span><span class="pl-s"><span class="pl-pds">'</span>socket<span class="pl-pds">'</span></span>,
- <span class="pl-s"><span class="pl-pds">'</span>host<span class="pl-pds">'</span></span><span class="pl-k">=</span><span class="pl-s"><span class="pl-pds">'</span>localhost<span class="pl-pds">'</span></span>,
- <span class="pl-s"><span class="pl-pds">'</span>port<span class="pl-pds">'</span></span><span class="pl-k">=</span><span class="pl-s"><span class="pl-pds">'</span>8888<span class="pl-pds">'</span></span>
+ <span class="pl-s"><span class="pl-pds">'</span>streaming<span class="pl-pds">'</span></span><span class="pl-k">=</span><span class="pl-s"><span class="pl-pds">'</span>source<span class="pl-pds">'</span></span>,
+ <span class="pl-s"><span class="pl-pds">'</span>format<span class="pl-pds">'</span></span><span class="pl-k">=</span><span class="pl-s"><span class="pl-pds">'</span>socket<span class="pl-pds">'</span></span>,
+ <span class="pl-s"><span class="pl-pds">'</span>host<span class="pl-pds">'</span></span><span class="pl-k">=</span><span class="pl-s"><span class="pl-pds">'</span>localhost<span class="pl-pds">'</span></span>,
+ <span class="pl-s"><span class="pl-pds">'</span>port<span class="pl-pds">'</span></span><span class="pl-k">=</span><span class="pl-s"><span class="pl-pds">'</span>8888<span class="pl-pds">'</span></span>,
+ <span class="pl-s"><span class="pl-pds">'</span>record_format<span class="pl-pds">'</span></span><span class="pl-k">=</span><span class="pl-s"><span class="pl-pds">'</span>csv<span class="pl-pds">'</span></span>, <span class="pl-k">//</span> can be csv <span class="pl-k">or</span> json, default is csv
+ <span class="pl-s"><span class="pl-pds">'</span>delimiter<span class="pl-pds">'</span></span><span class="pl-k">=</span><span class="pl-s"><span class="pl-pds">'</span>|<span class="pl-pds">'</span></span>
)</pre></div>
<p>will translate to</p>
<div class="highlight highlight-source-scala"><pre>spark.readStream
.schema(tableSchema)
.format(<span class="pl-s"><span class="pl-pds">"</span>socket<span class="pl-pds">"</span></span>)
.option(<span class="pl-s"><span class="pl-pds">"</span>host<span class="pl-pds">"</span></span>, <span class="pl-s"><span class="pl-pds">"</span>localhost<span class="pl-pds">"</span></span>)
- .option(<span class="pl-s"><span class="pl-pds">"</span>port<span class="pl-pds">"</span></span>, <span class="pl-s"><span class="pl-pds">"</span>8888<span class="pl-pds">"</span></span>)</pre></div>
+ .option(<span class="pl-s"><span class="pl-pds">"</span>port<span class="pl-pds">"</span></span>, <span class="pl-s"><span class="pl-pds">"</span>8888<span class="pl-pds">"</span></span>)
+ .option(<span class="pl-s"><span class="pl-pds">"</span>delimiter<span class="pl-pds">"</span></span>, <span class="pl-s"><span class="pl-pds">"</span>|<span class="pl-pds">"</span></span>)</pre></div>
</li>
<li>
<p>The sink table should have a TBLPROPERTY <code>'streaming'</code> equal to <code>true</code>, indicating it is a streaming table.</p>
@@ -621,9 +634,23 @@ TBLPROPERTIES(
<p>In the given STMPROPERTIES, user must specify <code>'trigger'</code>, its value must be <code>ProcessingTime</code> (In future, other value will be supported). User should also specify interval value for the streaming job.</p>
</li>
<li>
-<p>If the schema specifid in sink table is different from CTAS, the streaming job will fail</p>
+<p>If the schema specified in sink table is different from CTAS, the streaming job will fail</p>
</li>
</ul>
+<p>For Kafka data source, create the source table by:</p>
+<div class="highlight highlight-source-sql"><pre><span class="pl-k">CREATE</span> <span class="pl-k">TABLE</span> <span class="pl-en">source</span>(
+ name STRING,
+ age <span class="pl-k">INT</span>
+)
+STORED <span class="pl-k">AS</span> carbondata
+TBLPROPERTIES(
+ <span class="pl-s"><span class="pl-pds">'</span>streaming<span class="pl-pds">'</span></span><span class="pl-k">=</span><span class="pl-s"><span class="pl-pds">'</span>source<span class="pl-pds">'</span></span>,
+ <span class="pl-s"><span class="pl-pds">'</span>format<span class="pl-pds">'</span></span><span class="pl-k">=</span><span class="pl-s"><span class="pl-pds">'</span>kafka<span class="pl-pds">'</span></span>,
+ <span class="pl-s"><span class="pl-pds">'</span>kafka.bootstrap.servers<span class="pl-pds">'</span></span><span class="pl-k">=</span><span class="pl-s"><span class="pl-pds">'</span>kafkaserver:9092<span class="pl-pds">'</span></span>,
+ <span class="pl-s"><span class="pl-pds">'</span>subscribe<span class="pl-pds">'</span></span><span class="pl-k">=</span><span class="pl-s"><span class="pl-pds">'</span>test<span class="pl-pds">'</span></span>
+ <span class="pl-s"><span class="pl-pds">'</span>record_format<span class="pl-pds">'</span></span><span class="pl-k">=</span><span class="pl-s"><span class="pl-pds">'</span>csv<span class="pl-pds">'</span></span>, <span class="pl-k">//</span> can be csv <span class="pl-k">or</span> json, default is csv
+ <span class="pl-s"><span class="pl-pds">'</span>delimiter<span class="pl-pds">'</span></span><span class="pl-k">=</span><span class="pl-s"><span class="pl-pds">'</span>|<span class="pl-pds">'</span></span>
+)</pre></div>
<h5>
<a id="stop-stream" class="anchor" href="#stop-stream" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>STOP STREAM</h5>
<p>When this is issued, the streaming job will be stopped immediately. It will fail if the jobName specified is not exist.</p>
http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6ad7599a/content/supported-data-types-in-carbondata.html
----------------------------------------------------------------------
diff --git a/content/supported-data-types-in-carbondata.html b/content/supported-data-types-in-carbondata.html
index f346052..6c692b8 100644
--- a/content/supported-data-types-in-carbondata.html
+++ b/content/supported-data-types-in-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>
@@ -223,7 +231,10 @@
<li>BIGINT</li>
<li>DOUBLE</li>
<li>DECIMAL</li>
+<li>FLOAT</li>
+<li>BYTE</li>
</ul>
+<p><strong>NOTE</strong>: Float and Bytes are only supported for SDK and FileFormat.</p>
</li>
<li>
<p>Date/Time Types</p>
@@ -249,6 +260,8 @@ Please refer to TBLProperties in <a href="./ddl-of-carbondata.html#create-table"
</li>
<li>structs: STRUCT<code><col_name : data_type COMMENT col_comment, ...></code>
</li>
+<li>maps: MAP<code><primitive_type, data_type></code>
+</li>
</ul>
<p><strong>NOTE</strong>: Only 2 level complex type schema is supported for now.</p>
</li>
http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6ad7599a/content/timeseries-datamap-guide.html
----------------------------------------------------------------------
diff --git a/content/timeseries-datamap-guide.html b/content/timeseries-datamap-guide.html
index 73a4580..d34a013 100644
--- a/content/timeseries-datamap-guide.html
+++ b/content/timeseries-datamap-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>
[14/20] carbondata-site git commit: modified for 1.5.0 version
Posted by ch...@apache.org.
http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/6ad7599a/content/configuration-parameters.html
----------------------------------------------------------------------
diff --git a/content/configuration-parameters.html b/content/configuration-parameters.html
index ab89576..ff8e9ad 100644
--- a/content/configuration-parameters.html
+++ b/content/configuration-parameters.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>
@@ -212,7 +220,7 @@
<div>
<h1>
<a id="configuring-carbondata" class="anchor" href="#configuring-carbondata" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Configuring CarbonData</h1>
-<p>This guide explains the configurations that can be used to tune CarbonData to achieve better performance.Most of the properties that control the internal settings have reasonable default values.They are listed along with the properties along with explanation.</p>
+<p>This guide explains the configurations that can be used to tune CarbonData to achieve better performance.Most of the properties that control the internal settings have reasonable default values. They are listed along with the properties along with explanation.</p>
<ul>
<li><a href="#system-configuration">System Configuration</a></li>
<li><a href="#data-loading-configuration">Data Loading Configuration</a></li>
@@ -236,42 +244,42 @@
<tr>
<td>carbon.storelocation</td>
<td>spark.sql.warehouse.dir property value</td>
-<td>Location where CarbonData will create the store, and write the data in its custom format. If not specified,the path defaults to spark.sql.warehouse.dir property. NOTE: Store location should be in HDFS.</td>
+<td>Location where CarbonData will create the store, and write the data in its custom format. If not specified,the path defaults to spark.sql.warehouse.dir property. <strong>NOTE:</strong> Store location should be in HDFS.</td>
</tr>
<tr>
<td>carbon.ddl.base.hdfs.url</td>
<td>(none)</td>
-<td>To simplify and shorten the path to be specified in DDL/DML commands, this property is supported.This property is used to configure the HDFS relative path, the path configured in carbon.ddl.base.hdfs.url will be appended to the HDFS path configured in fs.defaultFS of core-site.xml. If this path is configured, then user need not pass the complete path while dataload. For example: If absolute path of the csv file is hdfs://10.18.101.155:54310/data/cnbc/2016/xyz.csv, the path "hdfs://10.18.101.155:54310" will come from property fs.defaultFS and user can configure the /data/cnbc/ as carbon.ddl.base.hdfs.url. Now while dataload user can specify the csv path as /2016/xyz.csv.</td>
+<td>To simplify and shorten the path to be specified in DDL/DML commands, this property is supported. This property is used to configure the HDFS relative path, the path configured in carbon.ddl.base.hdfs.url will be appended to the HDFS path configured in fs.defaultFS of core-site.xml. If this path is configured, then user need not pass the complete path while dataload. For example: If absolute path of the csv file is hdfs://10.18.101.155:54310/data/cnbc/2016/xyz.csv, the path "hdfs://10.18.101.155:54310" will come from property fs.defaultFS and user can configure the /data/cnbc/ as carbon.ddl.base.hdfs.url. Now while dataload user can specify the csv path as /2016/xyz.csv.</td>
</tr>
<tr>
<td>carbon.badRecords.location</td>
<td>(none)</td>
-<td>CarbonData can detect the records not conforming to defined table schema and isolate them as bad records.This property is used to specify where to store such bad records.</td>
+<td>CarbonData can detect the records not conforming to defined table schema and isolate them as bad records. This property is used to specify where to store such bad records.</td>
</tr>
<tr>
<td>carbon.streaming.auto.handoff.enabled</td>
<td>true</td>
-<td>CarbonData supports storing of streaming data.To have high throughput for streaming, the data is written in Row format which is highly optimized for write, but performs poorly for query.When this property is true and when the streaming data size reaches <em><strong>carbon.streaming.segment.max.size</strong></em>, CabonData will automatically convert the data to columnar format and optimize it for faster querying.<strong>NOTE:</strong> It is not recommended to keep the default value which is true.</td>
+<td>CarbonData supports storing of streaming data. To have high throughput for streaming, the data is written in Row format which is highly optimized for write, but performs poorly for query. When this property is true and when the streaming data size reaches <em><strong>carbon.streaming.segment.max.size</strong></em>, CabonData will automatically convert the data to columnar format and optimize it for faster querying.<strong>NOTE:</strong> It is not recommended to keep the default value which is true.</td>
</tr>
<tr>
<td>carbon.streaming.segment.max.size</td>
<td>1024000000</td>
-<td>CarbonData writes streaming data in row format which is optimized for high write throughput.This property defines the maximum size of data to be held is row format, beyond which it will be converted to columnar format in order to support high performane query, provided <em><strong>carbon.streaming.auto.handoff.enabled</strong></em> is true. <strong>NOTE:</strong> Setting higher value will impact the streaming ingestion. The value has to be configured in bytes.</td>
+<td>CarbonData writes streaming data in row format which is optimized for high write throughput. This property defines the maximum size of data to be held is row format, beyond which it will be converted to columnar format in order to support high performance query, provided <em><strong>carbon.streaming.auto.handoff.enabled</strong></em> is true. <strong>NOTE:</strong> Setting higher value will impact the streaming ingestion. The value has to be configured in bytes.</td>
</tr>
<tr>
<td>carbon.query.show.datamaps</td>
<td>true</td>
-<td>CarbonData stores datamaps as independent tables so as to allow independent maintenance to some extent.When this property is true,which is by default, show tables command will list all the tables including datatmaps(eg: Preaggregate table), else datamaps will be excluded from the table list.<strong>NOTE:</strong> It is generally not required for the user to do any maintenance operations on these tables and hence not required to be seen.But it is shown by default so that user or admin can get clear understanding of the system for capacity planning.</td>
+<td>CarbonData stores datamaps as independent tables so as to allow independent maintenance to some extent. When this property is true,which is by default, show tables command will list all the tables including datatmaps(eg: Preaggregate table), else datamaps will be excluded from the table list.<strong>NOTE:</strong> It is generally not required for the user to do any maintenance operations on these tables and hence not required to be seen.But it is shown by default so that user or admin can get clear understanding of the system for capacity planning.</td>
</tr>
<tr>
<td>carbon.segment.lock.files.preserve.hours</td>
<td>48</td>
-<td>In order to support parallel data loading onto the same table, CarbonData sequences(locks) at the granularity of segments.Operations affecting the segment(like IUD, alter) are blocked from parallel operations.This property value indicates the number of hours the segment lock files will be preserved after dataload. These lock files will be deleted with the clean command after the configured number of hours.</td>
+<td>In order to support parallel data loading onto the same table, CarbonData sequences(locks) at the granularity of segments.Operations affecting the segment(like IUD, alter) are blocked from parallel operations. This property value indicates the number of hours the segment lock files will be preserved after dataload. These lock files will be deleted with the clean command after the configured number of hours.</td>
</tr>
<tr>
<td>carbon.timestamp.format</td>
<td>yyyy-MM-dd HH:mm:ss</td>
-<td>CarbonData can understand data of timestamp type and process it in special manner.It can be so that the format of Timestamp data is different from that understood by CarbonData by default.This configuration allows users to specify the format of Timestamp in their data.</td>
+<td>CarbonData can understand data of timestamp type and process it in special manner.It can be so that the format of Timestamp data is different from that understood by CarbonData by default. This configuration allows users to specify the format of Timestamp in their data.</td>
</tr>
<tr>
<td>carbon.lock.type</td>
@@ -286,27 +294,32 @@
<tr>
<td>carbon.unsafe.working.memory.in.mb</td>
<td>512</td>
-<td>CarbonData supports storing data in off-heap memory for certain operations during data loading and query.This helps to avoid the Java GC and thereby improve the overall performance.The Minimum value recommeded is 512MB.Any value below this is reset to default value of 512MB.<strong>NOTE:</strong> The below formulas explain how to arrive at the off-heap size required.Memory Required For Data Loading:(<em>carbon.number.of.cores.while.loading</em>) * (Number of tables to load in parallel) * (<em>offheap.sort.chunk.size.inmb</em> + <em>carbon.blockletgroup.size.in.mb</em> + <em>carbon.blockletgroup.size.in.mb</em>/3.5 ). Memory required for Query:SPARK_EXECUTOR_INSTANCES * (<em>carbon.blockletgroup.size.in.mb</em> + <em>carbon.blockletgroup.size.in.mb</em> * 3.5) * spark.executor.cores</td>
+<td>CarbonData supports storing data in off-heap memory for certain operations during data loading and query. This helps to avoid the Java GC and thereby improve the overall performance. The Minimum value recommeded is 512MB. Any value below this is reset to default value of 512MB. <strong>NOTE:</strong> The below formulas explain how to arrive at the off-heap size required.Memory Required For Data Loading:(<em>carbon.number.of.cores.while.loading</em>) * (Number of tables to load in parallel) * (<em>offheap.sort.chunk.size.inmb</em> + <em>carbon.blockletgroup.size.in.mb</em> + <em>carbon.blockletgroup.size.in.mb</em>/3.5 ). Memory required for Query:SPARK_EXECUTOR_INSTANCES * (<em>carbon.blockletgroup.size.in.mb</em> + <em>carbon.blockletgroup.size.in.mb</em> * 3.5) * spark.executor.cores</td>
+</tr>
+<tr>
+<td>carbon.unsafe.driver.working.memory.in.mb</td>
+<td>60% of JVM Heap Memory</td>
+<td>CarbonData supports storing data in unsafe on-heap memory in driver for certain operations like insert into, query for loading datamap cache. The Minimum value recommended is 512MB.</td>
</tr>
<tr>
<td>carbon.update.sync.folder</td>
<td>/tmp/carbondata</td>
-<td>CarbonData maintains last modification time entries in modifiedTime.htmlt to determine the schema changes and reload only when necessary.This configuration specifies the path where the file needs to be written.</td>
+<td>CarbonData maintains last modification time entries in modifiedTime.htmlt to determine the schema changes and reload only when necessary. This configuration specifies the path where the file needs to be written.</td>
</tr>
<tr>
<td>carbon.invisible.segments.preserve.count</td>
<td>200</td>
-<td>CarbonData maintains each data load entry in tablestatus file. The entries from this file are not deleted for those segments that are compacted or dropped, but are made invisible.If the number of data loads are very high, the size and number of entries in tablestatus file can become too many causing unnecessary reading of all data.This configuration specifies the number of segment entries to be maintained afte they are compacted or dropped.Beyond this, the entries are moved to a separate history tablestatus file.<strong>NOTE:</strong> The entries in tablestatus file help to identify the operations performed on CarbonData table and is also used for checkpointing during various data manupulation operations.This is similar to AUDIT file maintaining all the operations and its status.Hence the entries are never deleted but moved to a separate history file.</td>
+<td>CarbonData maintains each data load entry in tablestatus file. The entries from this file are not deleted for those segments that are compacted or dropped, but are made invisible. If the number of data loads are very high, the size and number of entries in tablestatus file can become too many causing unnecessary reading of all data. This configuration specifies the number of segment entries to be maintained afte they are compacted or dropped.Beyond this, the entries are moved to a separate history tablestatus file. <strong>NOTE:</strong> The entries in tablestatus file help to identify the operations performed on CarbonData table and is also used for checkpointing during various data manupulation operations. This is similar to AUDIT file maintaining all the operations and its status.Hence the entries are never deleted but moved to a separate history file.</td>
</tr>
<tr>
<td>carbon.lock.retries</td>
<td>3</td>
-<td>CarbonData ensures consistency of operations by blocking certain operations from running in parallel.In order to block the operations from running in parallel, lock is obtained on the table.This configuration specifies the maximum number of retries to obtain the lock for any operations other than load.<strong>NOTE:</strong> Data manupulation operations like Compaction,UPDATE,DELETE or LOADING,UPDATE,DELETE are not allowed to run in parallel.How ever data loading can happen in parallel to compaction.</td>
+<td>CarbonData ensures consistency of operations by blocking certain operations from running in parallel. In order to block the operations from running in parallel, lock is obtained on the table. This configuration specifies the maximum number of retries to obtain the lock for any operations other than load. <strong>NOTE:</strong> Data manupulation operations like Compaction,UPDATE,DELETE or LOADING,UPDATE,DELETE are not allowed to run in parallel.How ever data loading can happen in parallel to compaction.</td>
</tr>
<tr>
<td>carbon.lock.retry.timeout.sec</td>
<td>5</td>
-<td>Specifies the interval between the retries to obtain the lock for any operation other than load.<strong>NOTE:</strong> Refer to <em><strong>carbon.lock.retries</strong></em> for understanding why CarbonData uses locks for operations.</td>
+<td>Specifies the interval between the retries to obtain the lock for any operation other than load. <strong>NOTE:</strong> Refer to <em><strong>carbon.lock.retries</strong></em> for understanding why CarbonData uses locks for operations.</td>
</tr>
</tbody>
</table>
@@ -324,7 +337,7 @@
<tr>
<td>carbon.number.of.cores.while.loading</td>
<td>2</td>
-<td>Number of cores to be used while loading data.This also determines the number of threads to be used to read the input files (csv) in parallel.<strong>NOTE:</strong> This configured value is used in every data loading step to parallelize the operations. Configuring a higher value can lead to increased early thread pre-emption by OS and there by reduce the overall performance.</td>
+<td>Number of cores to be used while loading data. This also determines the number of threads to be used to read the input files (csv) in parallel.<strong>NOTE:</strong> This configured value is used in every data loading step to parallelize the operations. Configuring a higher value can lead to increased early thread pre-emption by OS and there by reduce the overall performance.</td>
</tr>
<tr>
<td>carbon.sort.size</td>
@@ -344,12 +357,12 @@
<tr>
<td>carbon.options.bad.records.logger.enable</td>
<td>false</td>
-<td>CarbonData can identify the records that are not conformant to schema and isolate them as bad records.Enabling this configuration will make CarbonData to log such bad records.<strong>NOTE:</strong> If the input data contains many bad records, logging them will slow down the over all data loading throughput.The data load operation status would depend on the configuration in <em><strong>carbon.bad.records.action</strong></em>.</td>
+<td>CarbonData can identify the records that are not conformant to schema and isolate them as bad records. Enabling this configuration will make CarbonData to log such bad records.<strong>NOTE:</strong> If the input data contains many bad records, logging them will slow down the over all data loading throughput. The data load operation status would depend on the configuration in <em><strong>carbon.bad.records.action</strong></em>.</td>
</tr>
<tr>
<td>carbon.bad.records.action</td>
<td>FAIL</td>
-<td>CarbonData in addition to identifying the bad records, can take certain actions on such data.This configuration can have four types of actions for bad records namely FORCE, REDIRECT, IGNORE and FAIL. If set to FORCE then it auto-corrects the data by storing the bad records as NULL. If set to REDIRECT then bad records are written to the raw CSV instead of being loaded. If set to IGNORE then bad records are neither loaded nor written to the raw CSV. If set to FAIL then data loading fails if any bad records are found.</td>
+<td>CarbonData in addition to identifying the bad records, can take certain actions on such data. This configuration can have four types of actions for bad records namely FORCE, REDIRECT, IGNORE and FAIL. If set to FORCE then it auto-corrects the data by storing the bad records as NULL. If set to REDIRECT then bad records are written to the raw CSV instead of being loaded. If set to IGNORE then bad records are neither loaded nor written to the raw CSV. If set to FAIL then data loading fails if any bad records are found.</td>
</tr>
<tr>
<td>carbon.options.is.empty.data.bad.record</td>
@@ -364,48 +377,48 @@
<tr>
<td>carbon.blockletgroup.size.in.mb</td>
<td>64</td>
-<td>Please refer to <a href="./file-structure-of-carbondata.html#carbondata-file-format">file-structure-of-carbondata</a> to understand the storage format of CarbonData.The data are read as a group of blocklets which are called blocklet groups. This parameter specifies the size of each blocklet group. Higher value results in better sequential IO access.The minimum value is 16MB, any value lesser than 16MB will reset to the default value (64MB).<strong>NOTE:</strong> Configuring a higher value might lead to poor performance as an entire blocklet group will have to read into memory before processing.For filter queries with limit, it is <strong>not advisable</strong> to have a bigger blocklet size.For Aggregation queries which need to return more number of rows,bigger blocklet size is advisable.</td>
+<td>Please refer to <a href="./file-structure-of-carbondata.html#carbondata-file-format">file-structure-of-carbondata</a> to understand the storage format of CarbonData. The data are read as a group of blocklets which are called blocklet groups. This parameter specifies the size of each blocklet group. Higher value results in better sequential IO access. The minimum value is 16MB, any value lesser than 16MB will reset to the default value (64MB).<strong>NOTE:</strong> Configuring a higher value might lead to poor performance as an entire blocklet group will have to read into memory before processing.For filter queries with limit, it is <strong>not advisable</strong> to have a bigger blocklet size. For Aggregation queries which need to return more number of rows,bigger blocklet size is advisable.</td>
</tr>
<tr>
<td>carbon.sort.file.write.buffer.size</td>
<td>16384</td>
-<td>CarbonData sorts and writes data to intermediate files to limit the memory usage.This configuration determines the buffer size to be used for reading and writing such files. <strong>NOTE:</strong> This configuration is useful to tune IO and derive optimal performance.Based on the OS and underlying harddisk type, these values can significantly affect the overall performance.It is ideal to tune the buffersize equivalent to the IO buffer size of the OS.Recommended range is between 10240 to 10485760 bytes.</td>
+<td>CarbonData sorts and writes data to intermediate files to limit the memory usage. This configuration determines the buffer size to be used for reading and writing such files. <strong>NOTE:</strong> This configuration is useful to tune IO and derive optimal performance.Based on the OS and underlying harddisk type, these values can significantly affect the overall performance.It is ideal to tune the buffersize equivalent to the IO buffer size of the OS.Recommended range is between 10240 to 10485760 bytes.</td>
</tr>
<tr>
<td>carbon.sort.intermediate.files.limit</td>
<td>20</td>
-<td>CarbonData sorts and writes data to intermediate files to limit the memory usage.Before writing the target carbondat file, the data in these intermediate files needs to be sorted again so as to ensure the entire data in the data load is sorted.This configuration determines the minimum number of intermediate files after which merged sort is applied on them sort the data.<strong>NOTE:</strong> Intermediate merging happens on a separate thread in the background.Number of threads used is determined by <em><strong>carbon.merge.sort.reader.thread</strong></em>.Configuring a low value will cause more time to be spent in merging these intermediate merged files which can cause more IO.Configuring a high value would cause not to use the idle threads to do intermediate sort merges.Range of recommended values are between 2 and 50</td>
+<td>CarbonData sorts and writes data to intermediate files to limit the memory usage. Before writing the target carbondat file, the data in these intermediate files needs to be sorted again so as to ensure the entire data in the data load is sorted. This configuration determines the minimum number of intermediate files after which merged sort is applied on them sort the data.<strong>NOTE:</strong> Intermediate merging happens on a separate thread in the background.Number of threads used is determined by <em><strong>carbon.merge.sort.reader.thread</strong></em>.Configuring a low value will cause more time to be spent in merging these intermediate merged files which can cause more IO.Configuring a high value would cause not to use the idle threads to do intermediate sort merges.Range of recommended values are between 2 and 50</td>
</tr>
<tr>
<td>carbon.csv.read.buffersize.byte</td>
<td>1048576</td>
-<td>CarbonData uses Hadoop InputFormat to read the csv files.This configuration value is used to pass buffer size as input for the Hadoop MR job when reading the csv files.This value is configured in bytes.<strong>NOTE:</strong> Refer to <em><strong>org.apache.hadoop.mapreduce.InputFormat</strong></em> documentation for additional information.</td>
+<td>CarbonData uses Hadoop InputFormat to read the csv files. This configuration value is used to pass buffer size as input for the Hadoop MR job when reading the csv files. This value is configured in bytes.<strong>NOTE:</strong> Refer to <em><strong>org.apache.hadoop.mapreduce.InputFormat</strong></em> documentation for additional information.</td>
</tr>
<tr>
<td>carbon.merge.sort.reader.thread</td>
<td>3</td>
-<td>CarbonData sorts and writes data to intermediate files to limit the memory usage.When the intermediate files reaches <em><strong>carbon.sort.intermediate.files.limit</strong></em> the files will be merged,the number of threads specified in this configuration will be used to read the intermediate files for performing merge sort.<strong>NOTE:</strong> Refer to <em><strong>carbon.sort.intermediate.files.limit</strong></em> for operation description.Configuring less number of threads can cause merging to slow down over loading process where as configuring more number of threads can cause thread contention with threads in other data loading steps.Hence configure a fraction of <em><strong>carbon.number.of.cores.while.loading</strong></em>.</td>
+<td>CarbonData sorts and writes data to intermediate files to limit the memory usage. When the intermediate files reaches <em><strong>carbon.sort.intermediate.files.limit</strong></em> the files will be merged,the number of threads specified in this configuration will be used to read the intermediate files for performing merge sort.<strong>NOTE:</strong> Refer to <em><strong>carbon.sort.intermediate.files.limit</strong></em> for operation description.Configuring less number of threads can cause merging to slow down over loading process where as configuring more number of threads can cause thread contention with threads in other data loading steps.Hence configure a fraction of <em><strong>carbon.number.of.cores.while.loading</strong></em>.</td>
</tr>
<tr>
<td>carbon.concurrent.lock.retries</td>
<td>100</td>
-<td>CarbonData supports concurrent data loading onto same table.To ensure the loading status is correctly updated into the system,locks are used to sequence the status updation step.This configuration specifies the maximum number of retries to obtain the lock for updating the load status.<strong>NOTE:</strong> This value is high as more number of concurrent loading happens,more the chances of not able to obtain the lock when tried.Adjust this value according to the number of concurrent loading to be supported by the system.</td>
+<td>CarbonData supports concurrent data loading onto same table. To ensure the loading status is correctly updated into the system,locks are used to sequence the status updation step. This configuration specifies the maximum number of retries to obtain the lock for updating the load status. <strong>NOTE:</strong> This value is high as more number of concurrent loading happens,more the chances of not able to obtain the lock when tried. Adjust this value according to the number of concurrent loading to be supported by the system.</td>
</tr>
<tr>
<td>carbon.concurrent.lock.retry.timeout.sec</td>
<td>1</td>
-<td>Specifies the interval between the retries to obtain the lock for concurrent operations.<strong>NOTE:</strong> Refer to <em><strong>carbon.concurrent.lock.retries</strong></em> for understanding why CarbonData uses locks during data loading operations.</td>
+<td>Specifies the interval between the retries to obtain the lock for concurrent operations. <strong>NOTE:</strong> Refer to <em><strong>carbon.concurrent.lock.retries</strong></em> for understanding why CarbonData uses locks during data loading operations.</td>
</tr>
<tr>
<td>carbon.skip.empty.line</td>
<td>false</td>
-<td>The csv files givent to CarbonData for loading can contain empty lines.Based on the business scenario, this empty line might have to be ignored or needs to be treated as NULL value for all columns.In order to define this business behavior, this configuration is provided.<strong>NOTE:</strong> In order to consider NULL values for non string columns and continue with data load, <em><strong>carbon.bad.records.action</strong></em> need to be set to <strong>FORCE</strong>;else data load will be failed as bad records encountered.</td>
+<td>The csv files givent to CarbonData for loading can contain empty lines. Based on the business scenario, this empty line might have to be ignored or needs to be treated as NULL value for all columns.In order to define this business behavior, this configuration is provided.<strong>NOTE:</strong> In order to consider NULL values for non string columns and continue with data load, <em><strong>carbon.bad.records.action</strong></em> need to be set to <strong>FORCE</strong>;else data load will be failed as bad records encountered.</td>
</tr>
<tr>
<td>carbon.enable.calculate.size</td>
<td>true</td>
<td>
-<strong>For Load Operation</strong>: Setting this property calculates the size of the carbon data file (.carbondata) and carbon index file (.carbonindex) for every load and updates the table status file. <strong>For Describe Formatted</strong>: Setting this property calculates the total size of the carbon data files and carbon index files for the respective table and displays in describe formatted command.<strong>NOTE:</strong> This is useful to determine the overall size of the carbondata table and also get an idea of how the table is growing in order to take up other backup strategy decisions.</td>
+<strong>For Load Operation</strong>: Setting this property calculates the size of the carbon data file (.carbondata) and carbon index file (.carbonindex) for every load and updates the table status file. <strong>For Describe Formatted</strong>: Setting this property calculates the total size of the carbon data files and carbon index files for the respective table and displays in describe formatted command. <strong>NOTE:</strong> This is useful to determine the overall size of the carbondata table and also get an idea of how the table is growing in order to take up other backup strategy decisions.</td>
</tr>
<tr>
<td>carbon.cutOffTimestamp</td>
@@ -415,118 +428,128 @@
<tr>
<td>carbon.timegranularity</td>
<td>SECOND</td>
-<td>The configuration is used to specify the data granularity level such as DAY, HOUR, MINUTE, or SECOND.This helps to store more than 68 years of data into CarbonData.</td>
+<td>The configuration is used to specify the data granularity level such as DAY, HOUR, MINUTE, or SECOND. This helps to store more than 68 years of data into CarbonData.</td>
</tr>
<tr>
<td>carbon.use.local.dir</td>
<td>false</td>
-<td>CarbonData,during data loading, writes files to local temp directories before copying the files to HDFS.This configuration is used to specify whether CarbonData can write locally to tmp directory of the container or to the YARN application directory.</td>
+<td>CarbonData,during data loading, writes files to local temp directories before copying the files to HDFS. This configuration is used to specify whether CarbonData can write locally to tmp directory of the container or to the YARN application directory.</td>
</tr>
<tr>
<td>carbon.use.multiple.temp.dir</td>
<td>false</td>
-<td>When multiple disks are present in the system, YARN is generally configured with multiple disks to be used as temp directories for managing the containers.This configuration specifies whether to use multiple YARN local directories during data loading for disk IO load balancing.Enable <em><strong>carbon.use.local.dir</strong></em> for this configuration to take effect.<strong>NOTE:</strong> Data Loading is an IO intensive operation whose performance can be limited by the disk IO threshold, particularly during multi table concurrent data load.Configuring this parameter, balances the disk IO across multiple disks there by improving the over all load performance.</td>
+<td>When multiple disks are present in the system, YARN is generally configured with multiple disks to be used as temp directories for managing the containers. This configuration specifies whether to use multiple YARN local directories during data loading for disk IO load balancing.Enable <em><strong>carbon.use.local.dir</strong></em> for this configuration to take effect. <strong>NOTE:</strong> Data Loading is an IO intensive operation whose performance can be limited by the disk IO threshold, particularly during multi table concurrent data load.Configuring this parameter, balances the disk IO across multiple disks there by improving the over all load performance.</td>
</tr>
<tr>
<td>carbon.sort.temp.compressor</td>
<td>(none)</td>
-<td>CarbonData writes every <em><strong>carbon.sort.size</strong></em> number of records to intermediate temp files during data loading to ensure memory footprint is within limits.These temporary files cab be compressed and written in order to save the storage space.This configuration specifies the name of compressor to be used to compress the intermediate sort temp files during sort procedure in data loading.The valid values are 'SNAPPY','GZIP','BZIP2','LZ4','ZSTD' and empty. By default, empty means that Carbondata will not compress the sort temp files.<strong>NOTE:</strong> Compressor will be useful if you encounter disk bottleneck.Since the data needs to be compressed and decompressed,it involves additional CPU cycles,but is compensated by the high IO throughput due to less data to be written or read from the disks.</td>
+<td>CarbonData writes every <em><strong>carbon.sort.size</strong></em> number of records to intermediate temp files during data loading to ensure memory footprint is within limits. These temporary files can be compressed and written in order to save the storage space. This configuration specifies the name of compressor to be used to compress the intermediate sort temp files during sort procedure in data loading. The valid values are 'SNAPPY','GZIP','BZIP2','LZ4','ZSTD' and empty. By default, empty means that Carbondata will not compress the sort temp files. <strong>NOTE:</strong> Compressor will be useful if you encounter disk bottleneck.Since the data needs to be compressed and decompressed,it involves additional CPU cycles,but is compensated by the high IO throughput due to less data to be written or read from the disks.</td>
</tr>
<tr>
<td>carbon.load.skewedDataOptimization.enabled</td>
<td>false</td>
-<td>During data loading,CarbonData would divide the number of blocks equally so as to ensure all executors process same number of blocks.This mechanism satisfies most of the scenarios and ensures maximum parallel processing for optimal data loading performance.In some business scenarios, there might be scenarios where the size of blocks vary significantly and hence some executors would have to do more work if they get blocks containing more data. This configuration enables size based block allocation strategy for data loading.When loading, carbondata will use file size based block allocation strategy for task distribution. It will make sure that all the executors process the same size of data.<strong>NOTE:</strong> This configuration is useful if the size of your input data files varies widely, say 1MB~1GB.For this configuration to work effectively,knowing the data pattern and size is important and necessary.</td>
+<td>During data loading,CarbonData would divide the number of blocks equally so as to ensure all executors process same number of blocks. This mechanism satisfies most of the scenarios and ensures maximum parallel processing for optimal data loading performance.In some business scenarios, there might be scenarios where the size of blocks vary significantly and hence some executors would have to do more work if they get blocks containing more data. This configuration enables size based block allocation strategy for data loading. When loading, carbondata will use file size based block allocation strategy for task distribution. It will make sure that all the executors process the same size of data.<strong>NOTE:</strong> This configuration is useful if the size of your input data files varies widely, say 1MB to 1GB.For this configuration to work effectively,knowing the data pattern and size is important and necessary.</td>
</tr>
<tr>
<td>carbon.load.min.size.enabled</td>
<td>false</td>
-<td>During Data Loading, CarbonData would divide the number of files among the available executors to parallelize the loading operation.When the input data files are very small, this action causes to generate many small carbondata files.This configuration determines whether to enable node minumun input data size allocation strategy for data loading.It will make sure that the node load the minimum amount of data there by reducing number of carbondata files.<strong>NOTE:</strong> This configuration is useful if the size of the input data files are very small, like 1MB~256MB.Refer to <em><strong>load_min_size_inmb</strong></em> to configure the minimum size to be considered for splitting files among executors.</td>
+<td>During Data Loading, CarbonData would divide the number of files among the available executors to parallelize the loading operation. When the input data files are very small, this action causes to generate many small carbondata files. This configuration determines whether to enable node minumun input data size allocation strategy for data loading.It will make sure that the node load the minimum amount of data there by reducing number of carbondata files.<strong>NOTE:</strong> This configuration is useful if the size of the input data files are very small, like 1MB to 256MB.Refer to <em><strong>load_min_size_inmb</strong></em> to configure the minimum size to be considered for splitting files among executors.</td>
</tr>
<tr>
<td>enable.data.loading.statistics</td>
<td>false</td>
-<td>CarbonData has extensive logging which would be useful for debugging issues related to performance or hard to locate issues.This configuration when made <em><strong>true</strong></em> would log additional data loading statistics information to more accurately locate the issues being debugged.<strong>NOTE:</strong> Enabling this would log more debug information to log files, there by increasing the log files size significantly in short span of time.It is advised to configure the log files size, retention of log files parameters in log4j properties appropriately.Also extensive logging is an increased IO operation and hence over all data loading performance might get reduced.Therefore it is recommened to enable this configuration only for the duration of debugging.</td>
+<td>CarbonData has extensive logging which would be useful for debugging issues related to performance or hard to locate issues. This configuration when made <em><strong>true</strong></em> would log additional data loading statistics information to more accurately locate the issues being debugged. <strong>NOTE:</strong> Enabling this would log more debug information to log files, there by increasing the log files size significantly in short span of time.It is advised to configure the log files size, retention of log files parameters in log4j properties appropriately. Also extensive logging is an increased IO operation and hence over all data loading performance might get reduced. Therefore it is recommended to enable this configuration only for the duration of debugging.</td>
</tr>
<tr>
<td>carbon.dictionary.chunk.size</td>
<td>10000</td>
-<td>CarbonData generates dictionary keys and writes them to separate dictionary file during data loading.To optimize the IO, this configuration determines the number of dictionary keys to be persisted to dictionary file at a time.<strong>NOTE:</strong> Writing to file also serves as a commit point to the dictionary generated.Increasing more values in memory causes more data loss during system or application failure.It is advised to alter this configuration judiciously.</td>
+<td>CarbonData generates dictionary keys and writes them to separate dictionary file during data loading. To optimize the IO, this configuration determines the number of dictionary keys to be persisted to dictionary file at a time. <strong>NOTE:</strong> Writing to file also serves as a commit point to the dictionary generated.Increasing more values in memory causes more data loss during system or application failure.It is advised to alter this configuration judiciously.</td>
</tr>
<tr>
<td>dictionary.worker.threads</td>
<td>1</td>
-<td>CarbonData supports Optimized data loading by relying on a dictionary server.Dictionary server helps to maintain dictionary values independent of the data loading and there by avoids reading the same input data multiples times.This configuration determines the number of concurrent dictionary generation or request that needs to be served by the dictionary server.<strong>NOTE:</strong> This configuration takes effect when <em><strong>carbon.options.single.pass</strong></em> is configured as true.Please refer to <em>carbon.options.single.pass</em>to understand how dictionary server optimizes data loading.</td>
+<td>CarbonData supports Optimized data loading by relying on a dictionary server. Dictionary server helps to maintain dictionary values independent of the data loading and there by avoids reading the same input data multiples times. This configuration determines the number of concurrent dictionary generation or request that needs to be served by the dictionary server. <strong>NOTE:</strong> This configuration takes effect when <em><strong>carbon.options.single.pass</strong></em> is configured as true.Please refer to <em>carbon.options.single.pass</em>to understand how dictionary server optimizes data loading.</td>
</tr>
<tr>
<td>enable.unsafe.sort</td>
<td>true</td>
-<td>CarbonData supports unsafe operations of Java to avoid GC overhead for certain operations.This configuration enables to use unsafe functions in CarbonData.<strong>NOTE:</strong> For operations like data loading, which generates more short lived Java objects, Java GC can be a bottle neck.Using unsafe can overcome the GC overhead and improve the overall performance.</td>
+<td>CarbonData supports unsafe operations of Java to avoid GC overhead for certain operations. This configuration enables to use unsafe functions in CarbonData. <strong>NOTE:</strong> For operations like data loading, which generates more short lived Java objects, Java GC can be a bottle neck. Using unsafe can overcome the GC overhead and improve the overall performance.</td>
</tr>
<tr>
<td>enable.offheap.sort</td>
<td>true</td>
-<td>CarbonData supports storing data in off-heap memory for certain operations during data loading and query.This helps to avoid the Java GC and thereby improve the overall performance.This configuration enables using off-heap memory for sorting of data during data loading.<strong>NOTE:</strong> <em><strong>enable.unsafe.sort</strong></em> configuration needs to be configured to true for using off-heap</td>
+<td>CarbonData supports storing data in off-heap memory for certain operations during data loading and query. This helps to avoid the Java GC and thereby improve the overall performance. This configuration enables using off-heap memory for sorting of data during data loading.<strong>NOTE:</strong> <em><strong>enable.unsafe.sort</strong></em> configuration needs to be configured to true for using off-heap</td>
</tr>
<tr>
<td>enable.inmemory.merge.sort</td>
<td>false</td>
-<td>CarbonData sorts and writes data to intermediate files to limit the memory usage.These intermediate files needs to be sorted again using merge sort before writing to the final carbondata file.Performing merge sort in memory would increase the sorting performance at the cost of increased memory footprint. This Configuration specifies to do in-memory merge sort or to do file based merge sort.</td>
+<td>CarbonData sorts and writes data to intermediate files to limit the memory usage. These intermediate files needs to be sorted again using merge sort before writing to the final carbondata file.Performing merge sort in memory would increase the sorting performance at the cost of increased memory footprint. This Configuration specifies to do in-memory merge sort or to do file based merge sort.</td>
</tr>
<tr>
<td>carbon.load.sort.scope</td>
<td>LOCAL_SORT</td>
-<td>CarbonData can support various sorting options to match the balance between load and query performance.LOCAL_SORT:All the data given to an executor in the single load is fully sorted and written to carondata files.Data loading performance is reduced a little as the entire data needs to be sorted in the executor.BATCH_SORT:Sorts the data in batches of configured size and writes to carbondata files.Data loading performance increases as the entire data need not be sorted.But query performance will get reduced due to false positives in block pruning and also due to more number of carbondata files written.Due to more number of carbondata files, if identified blocks > cluster parallelism, query performance and concurrency will get reduced.GLOBAL SORT:Entire data in the data load is fully sorted and written to carbondata files.Data loading perfromance would get reduced as the entire data needs to be sorted.But the query performance increases significantly due to very less false posi
tives and concurrency is also improved.<strong>NOTE:</strong> when BATCH_SORTis configured, it is recommended to keep <em><strong>carbon.load.batch.sort.size.inmb</strong></em> > <em><strong>carbon.blockletgroup.size.in.mb</strong></em>
+<td>CarbonData can support various sorting options to match the balance between load and query performance. LOCAL_SORT:All the data given to an executor in the single load is fully sorted and written to carbondata files. Data loading performance is reduced a little as the entire data needs to be sorted in the executor. BATCH_SORT:Sorts the data in batches of configured size and writes to carbondata files. Data loading performance increases as the entire data need not be sorted.But query performance will get reduced due to false positives in block pruning and also due to more number of carbondata files written.Due to more number of carbondata files, if identified blocks > cluster parallelism, query performance and concurrency will get reduced.GLOBAL SORT:Entire data in the data load is fully sorted and written to carbondata files. Data loading performance would get reduced as the entire data needs to be sorted.But the query performance increases significantly due to very less fals
e positives and concurrency is also improved. <strong>NOTE:</strong> when BATCH_SORT is configured, it is recommended to keep <em><strong>carbon.load.batch.sort.size.inmb</strong></em> > <em><strong>carbon.blockletgroup.size.in.mb</strong></em>
</td>
</tr>
<tr>
<td>carbon.load.batch.sort.size.inmb</td>
<td>0</td>
-<td>When <em><strong>carbon.load.sort.scope</strong></em> is configured as <em><strong>BATCH_SORT</strong></em>,This configuration needs to be added to specify the batch size for sorting and writing to carbondata files.<strong>NOTE:</strong> It is recommended to keep the value around 45% of <em><strong>carbon.sort.storage.inmemory.size.inmb</strong></em> to avoid spill to disk.Also it is recommended to keep the value higher than <em><strong>carbon.blockletgroup.size.in.mb</strong></em>. Refer to <em>carbon.load.sort.scope</em> for more information on sort options and the advantages/disadvantges of each option.</td>
+<td>When <em><strong>carbon.load.sort.scope</strong></em> is configured as <em><strong>BATCH_SORT</strong></em>, this configuration needs to be added to specify the batch size for sorting and writing to carbondata files. <strong>NOTE:</strong> It is recommended to keep the value around 45% of <em><strong>carbon.sort.storage.inmemory.size.inmb</strong></em> to avoid spill to disk. Also it is recommended to keep the value higher than <em><strong>carbon.blockletgroup.size.in.mb</strong></em>. Refer to <em>carbon.load.sort.scope</em> for more information on sort options and the advantages/disadvantages of each option.</td>
</tr>
<tr>
<td>carbon.dictionary.server.port</td>
<td>2030</td>
-<td>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.Single pass loading can be enabled using the option <em><strong>carbon.options.single.pass</strong></em>.When this option is specified, a dictionary server will be internally started to handle the dictionary generation and query requests.This configuration specifies the port on which the server need to listen for incoming requests.Port value ranges between 0-65535</td>
+<td>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.Single pass loading can be enabled using the option <em><strong>carbon.options.single.pass</strong></em>. When this option is specified, a dictionary server will be internally started to handle the dictionary generation and query requests. This configuration specifies the port on which the server need to listen for incoming requests.Port value ranges between 0-65535</td>
</tr>
<tr>
<td>carbon.merge.sort.prefetch</td>
<td>true</td>
-<td>CarbonData writes every <em><strong>carbon.sort.size</strong></em> number of records to intermediate temp files during data loading to ensure memory footprint is within limits.These intermediate temp files will have to be sorted using merge sort before writing into CarbonData format.This configuration enables pre fetching of data from these temp files in order to optimize IO and speed up data loading process.</td>
+<td>CarbonData writes every <em><strong>carbon.sort.size</strong></em> number of records to intermediate temp files during data loading to ensure memory footprint is within limits. These intermediate temp files will have to be sorted using merge sort before writing into CarbonData format. This configuration enables pre fetching of data from these temp files in order to optimize IO and speed up data loading process.</td>
</tr>
<tr>
<td>carbon.loading.prefetch</td>
<td>false</td>
-<td>CarbonData uses univocity parser to read csv files.This configuration is used to inform the parser whether it can prefetch the data from csv files to speed up the reading.<strong>NOTE:</strong> Enabling prefetch improves the data loading performance, but needs higher memory to keep more records which are read ahead from disk.</td>
+<td>CarbonData uses univocity parser to read csv files. This configuration is used to inform the parser whether it can prefetch the data from csv files to speed up the reading.<strong>NOTE:</strong> Enabling prefetch improves the data loading performance, but needs higher memory to keep more records which are read ahead from disk.</td>
</tr>
<tr>
<td>carbon.prefetch.buffersize</td>
<td>1000</td>
-<td>When the configuration <em><strong>carbon.merge.sort.prefetch</strong></em> is configured to true, we need to set the number of records that can be prefetched.This configuration is used specify the number of records to be prefetched.**NOTE: **Configuring more number of records to be prefetched increases memory footprint as more records will have to be kept in memory.</td>
+<td>When the configuration <em><strong>carbon.merge.sort.prefetch</strong></em> is configured to true, we need to set the number of records that can be prefetched. This configuration is used specify the number of records to be prefetched.**NOTE: **Configuring more number of records to be prefetched increases memory footprint as more records will have to be kept in memory.</td>
</tr>
<tr>
<td>load_min_size_inmb</td>
<td>256</td>
-<td>This configuration is used along with <em><strong>carbon.load.min.size.enabled</strong></em>.This determines the minimum size of input files to be considered for distribution among executors while data loading.<strong>NOTE:</strong> Refer to <em><strong>carbon.load.min.size.enabled</strong></em> for understanding when this configuration needs to be used and its advantages and disadvantages.</td>
+<td>This configuration is used along with <em><strong>carbon.load.min.size.enabled</strong></em>. This determines the minimum size of input files to be considered for distribution among executors while data loading.<strong>NOTE:</strong> Refer to <em><strong>carbon.load.min.size.enabled</strong></em> for understanding when this configuration needs to be used and its advantages and disadvantages.</td>
</tr>
<tr>
<td>carbon.load.sortmemory.spill.percentage</td>
<td>0</td>
-<td>During data loading, some data pages are kept in memory upto memory configured in <em><strong>carbon.sort.storage.inmemory.size.inmb</strong></em> beyond which they are spilled to disk as intermediate temporary sort files.This configuration determines after what percentage data needs to be spilled to disk.<strong>NOTE:</strong> Without this configuration, when the data pages occupy upto configured memory, new data pages would be dumped to disk and old pages are still maintained in disk.</td>
+<td>During data loading, some data pages are kept in memory upto memory configured in <em><strong>carbon.sort.storage.inmemory.size.inmb</strong></em> beyond which they are spilled to disk as intermediate temporary sort files. This configuration determines after what percentage data needs to be spilled to disk. <strong>NOTE:</strong> Without this configuration, when the data pages occupy upto configured memory, new data pages would be dumped to disk and old pages are still maintained in disk.</td>
</tr>
<tr>
-<td>carbon.load.directWriteHdfs.enabled</td>
+<td>carbon.load.directWriteToStorePath.enabled</td>
<td>false</td>
-<td>During data load all the carbondata files are written to local disk and finally copied to the target location in HDFS.Enabling this parameter will make carrbondata files to be written directly onto target HDFS location bypassing the local disk.<strong>NOTE:</strong> Writing directly to HDFS saves local disk IO(once for writing the files and again for copying to HDFS) there by improving the performance.But the drawback is when data loading fails or the application crashes, unwanted carbondata files will remain in the target HDFS location until it is cleared during next data load or by running <em>CLEAN FILES</em> DDL command</td>
+<td>During data load, all the carbondata files are written to local disk and finally copied to the target store location in HDFS/S3. Enabling this parameter will make carbondata files to be written directly onto target HDFS/S3 location bypassing the local disk.<strong>NOTE:</strong> Writing directly to HDFS/S3 saves local disk IO(once for writing the files and again for copying to HDFS/S3) there by improving the performance. But the drawback is when data loading fails or the application crashes, unwanted carbondata files will remain in the target HDFS/S3 location until it is cleared during next data load or by running <em>CLEAN FILES</em> DDL command</td>
</tr>
<tr>
<td>carbon.options.serialization.null.format</td>
<td>\N</td>
-<td>Based on the business scenarios, some columns might need to be loaded with null values.As null value cannot be written in csv files, some special characters might be adopted to specify null values.This configuration can be used to specify the null values format in the data being loaded.</td>
+<td>Based on the business scenarios, some columns might need to be loaded with null values. As null value cannot be written in csv files, some special characters might be adopted to specify null values. This configuration can be used to specify the null values format in the data being loaded.</td>
</tr>
<tr>
<td>carbon.sort.storage.inmemory.size.inmb</td>
<td>512</td>
-<td>CarbonData writes every <em><strong>carbon.sort.size</strong></em> number of records to intermediate temp files during data loading to ensure memory footprint is within limits.When <em><strong>enable.unsafe.sort</strong></em> configuration is enabled, instead of using <em><strong>carbon.sort.size</strong></em> which is based on rows count, size occupied in memory is used to determine when to flush data pages to intermediate temp files.This configuration determines the memory to be used for storing data pages in memory.<strong>NOTE:</strong> Configuring a higher values ensures more data is maintained in memory and hence increases data loading performance due to reduced or no IO.Based on the memory availability in the nodes of the cluster, configure the values accordingly.</td>
+<td>CarbonData writes every <em><strong>carbon.sort.size</strong></em> number of records to intermediate temp files during data loading to ensure memory footprint is within limits. When <em><strong>enable.unsafe.sort</strong></em> configuration is enabled, instead of using <em><strong>carbon.sort.size</strong></em> which is based on rows count, size occupied in memory is used to determine when to flush data pages to intermediate temp files. This configuration determines the memory to be used for storing data pages in memory. <strong>NOTE:</strong> Configuring a higher value ensures more data is maintained in memory and hence increases data loading performance due to reduced or no IO.Based on the memory availability in the nodes of the cluster, configure the values accordingly.</td>
+</tr>
+<tr>
+<td>carbon.column.compressor</td>
+<td>snappy</td>
+<td>CarbonData will compress the column values using the compressor specified by this configuration. Currently CarbonData supports 'snappy' and 'zstd' compressors.</td>
+</tr>
+<tr>
+<td>carbon.minmax.allowed.byte.count</td>
+<td>200</td>
+<td>CarbonData will write the min max values for string/varchar types column using the byte count specified by this configuration. Max value is 1000 bytes(500 characters) and Min value is 10 bytes(5 characters). <strong>NOTE:</strong> This property is useful for reducing the store size thereby improving the query performance but can lead to query degradation if value is not configured properly.</td>
</tr>
</tbody>
</table>
@@ -544,22 +567,22 @@
<tr>
<td>carbon.number.of.cores.while.compacting</td>
<td>2</td>
-<td>Number of cores to be used while compacting data.This also determines the number of threads to be used to read carbondata files in parallel.</td>
+<td>Number of cores to be used while compacting data. This also determines the number of threads to be used to read carbondata files in parallel.</td>
</tr>
<tr>
<td>carbon.compaction.level.threshold</td>
<td>4, 3</td>
-<td>Each CarbonData load will create one segment, if every load is small in size it will generate many small file over a period of time impacting the query performance.This configuration is for minor compaction which decides how many segments to be merged. Configuration is of the form (x,y). Compaction will be triggered for every x segments and form a single level 1 compacted segment.When the number of compacted level 1 segments reach y, compaction will be triggered again to merge them to form a single level 2 segment. For example: If it is set as 2, 3 then minor compaction will be triggered for every 2 segments. 3 is the number of level 1 compacted segments which is further compacted to new segment.<strong>NOTE:</strong> When <em><strong>carbon.enable.auto.load.merge</strong></em> is <strong>true</strong>, Configuring higher values cause overall data loading time to increase as compaction will be triggered after data loading is complete but status is not returned till compaction is
complete. But compacting more number of segments can increase query performance.Hence optimal values needs to be configured based on the business scenario.Valid values are bwteen 0 to 100.</td>
+<td>Each CarbonData load will create one segment, if every load is small in size it will generate many small file over a period of time impacting the query performance. This configuration is for minor compaction which decides how many segments to be merged. Configuration is of the form (x,y). Compaction will be triggered for every x segments and form a single level 1 compacted segment. When the number of compacted level 1 segments reach y, compaction will be triggered again to merge them to form a single level 2 segment. For example: If it is set as 2, 3 then minor compaction will be triggered for every 2 segments. 3 is the number of level 1 compacted segments which is further compacted to new segment.<strong>NOTE:</strong> When <em><strong>carbon.enable.auto.load.merge</strong></em> is <strong>true</strong>, configuring higher values cause overall data loading time to increase as compaction will be triggered after data loading is complete but status is not returned till compaction
is complete. But compacting more number of segments can increase query performance.Hence optimal values needs to be configured based on the business scenario. Valid values are between 0 to 100.</td>
</tr>
<tr>
<td>carbon.major.compaction.size</td>
<td>1024</td>
-<td>To improve query performance and All the segments can be merged and compacted to a single segment upto configured size.This Major compaction size can be configured using this parameter. Sum of the segments which is below this threshold will be merged. This value is expressed in MB.</td>
+<td>To improve query performance and all the segments can be merged and compacted to a single segment upto configured size. This Major compaction size can be configured using this parameter. Sum of the segments which is below this threshold will be merged. This value is expressed in MB.</td>
</tr>
<tr>
<td>carbon.horizontal.compaction.enable</td>
<td>true</td>
-<td>CarbonData supports DELETE/UPDATE functionality by creating delta data files for existing carbondata files.These delta files would grow as more number of DELETE/UPDATE operations are performed.Compaction of these delta files are termed as horizontal compaction.This configuration is used to turn ON/OFF horizontal compaction. After every DELETE and UPDATE statement, horizontal compaction may occur in case the delta (DELETE/ UPDATE) files becomes more than specified threshold.**NOTE: **Having many delta files will reduce the query performance as scan has to happen on all these files before the final state of data can be decided.Hence it is advisable to keep horizontal compaction enabled and configure reasonable values to <em><strong>carbon.horizontal.UPDATE.compaction.threshold</strong></em> and <em><strong>carbon.horizontal.DELETE.compaction.threshold</strong></em>
+<td>CarbonData supports DELETE/UPDATE functionality by creating delta data files for existing carbondata files. These delta files would grow as more number of DELETE/UPDATE operations are performed.Compaction of these delta files are termed as horizontal compaction. This configuration is used to turn ON/OFF horizontal compaction. After every DELETE and UPDATE statement, horizontal compaction may occur in case the delta (DELETE/ UPDATE) files becomes more than specified threshold.**NOTE: **Having many delta files will reduce the query performance as scan has to happen on all these files before the final state of data can be decided.Hence it is advisable to keep horizontal compaction enabled and configure reasonable values to <em><strong>carbon.horizontal.UPDATE.compaction.threshold</strong></em> and <em><strong>carbon.horizontal.DELETE.compaction.threshold</strong></em>
</td>
</tr>
<tr>
@@ -575,7 +598,7 @@
<tr>
<td>carbon.update.segment.parallelism</td>
<td>1</td>
-<td>CarbonData processes the UPDATE operations by grouping records belonging to a segment into a single executor task.When the amount of data to be updated is more, this behavior causes problems like restarting of executor due to low memory and data-spill related errors.This property specifies the parallelism for each segment during update.<strong>NOTE:</strong> It is recommended to set this value to a multiple of the number of executors for balance.Values range between 1 to 1000.</td>
+<td>CarbonData processes the UPDATE operations by grouping records belonging to a segment into a single executor task. When the amount of data to be updated is more, this behavior causes problems like restarting of executor due to low memory and data-spill related errors. This property specifies the parallelism for each segment during update.<strong>NOTE:</strong> It is recommended to set this value to a multiple of the number of executors for balance.Values range between 1 to 1000.</td>
</tr>
<tr>
<td>carbon.numberof.preserve.segments</td>
@@ -585,32 +608,32 @@
<tr>
<td>carbon.allowed.compaction.days</td>
<td>0</td>
-<td>This configuration is used to control on the number of recent segments that needs to be compacted, ignoring the older ones.This congifuration is in days.For Example: If the configuration is 2, then the segments which are loaded in the time frame of past 2 days only will get merged. Segments which are loaded earlier than 2 days will not be merged. This configuration is disabled by default.<strong>NOTE:</strong> This configuration is useful when a bulk of history data is loaded into the carbondata.Query on this data is less frequent.In such cases involving these segments also into compacation will affect the resource consumption, increases overall compaction time.</td>
+<td>This configuration is used to control on the number of recent segments that needs to be compacted, ignoring the older ones. This configuration is in days.For Example: If the configuration is 2, then the segments which are loaded in the time frame of past 2 days only will get merged. Segments which are loaded earlier than 2 days will not be merged. This configuration is disabled by default.<strong>NOTE:</strong> This configuration is useful when a bulk of history data is loaded into the carbondata.Query on this data is less frequent.In such cases involving these segments also into compaction will affect the resource consumption, increases overall compaction time.</td>
</tr>
<tr>
<td>carbon.enable.auto.load.merge</td>
<td>false</td>
-<td>Compaction can be automatically triggered once data load completes.This ensures that the segments are merged in time and thus query times doesnt increase with increase in segments.This configuration enables to do compaction along with data loading.**NOTE: **Compaction will be triggered once the data load completes.But the status of data load wait till the compaction is completed.Hence it might look like data loading time has increased, but thats not the case.Moreover failure of compaction will not affect the data loading status.If data load had completed successfully, the status would be updated and segments are committed.However, failure while data loading, will not trigger compaction and error is returned immediately.</td>
+<td>Compaction can be automatically triggered once data load completes. This ensures that the segments are merged in time and thus query times does not increase with increase in segments. This configuration enables to do compaction along with data loading.**NOTE: **Compaction will be triggered once the data load completes.But the status of data load wait till the compaction is completed.Hence it might look like data loading time has increased, but thats not the case.Moreover failure of compaction will not affect the data loading status.If data load had completed successfully, the status would be updated and segments are committed.However, failure while data loading, will not trigger compaction and error is returned immediately.</td>
</tr>
<tr>
<td>carbon.enable.page.level.reader.in.compaction</td>
<td>true</td>
-<td>Enabling page level reader for compaction reduces the memory usage while compacting more number of segments. It allows reading only page by page instead of reading whole blocklet to memory.<strong>NOTE:</strong> Please refer to <a href="./file-structure-of-carbondata.html#carbondata-file-format">file-structure-of-carbondata</a> to understand the storage format of CarbonData and concepts of pages.</td>
+<td>Enabling page level reader for compaction reduces the memory usage while compacting more number of segments. It allows reading only page by page instead of reading whole blocklet to memory. <strong>NOTE:</strong> Please refer to <a href="./file-structure-of-carbondata.html#carbondata-file-format">file-structure-of-carbondata</a> to understand the storage format of CarbonData and concepts of pages.</td>
</tr>
<tr>
<td>carbon.concurrent.compaction</td>
<td>true</td>
-<td>Compaction of different tables can be executed concurrently.This configuration determines whether to compact all qualifying tables in parallel or not.**NOTE: **Compacting concurrently is a resource demanding operation and needs more resouces there by affecting the query performance also.This configuration is <strong>deprecated</strong> and might be removed in future releases.</td>
+<td>Compaction of different tables can be executed concurrently. This configuration determines whether to compact all qualifying tables in parallel or not. **NOTE: **Compacting concurrently is a resource demanding operation and needs more resources there by affecting the query performance also. This configuration is <strong>deprecated</strong> and might be removed in future releases.</td>
</tr>
<tr>
<td>carbon.compaction.prefetch.enable</td>
<td>false</td>
-<td>Compaction operation is similar to Query + data load where in data from qualifying segments are queried and data loading performed to generate a new single segment.This configuration determines whether to query ahead data from segments and feed it for data loading.**NOTE: **This configuration is disabled by default as it needs extra resources for querying ahead extra data.Based on the memory availability on the cluster, user can enable it to improve compaction performance.</td>
+<td>Compaction operation is similar to Query + data load where in data from qualifying segments are queried and data loading performed to generate a new single segment. This configuration determines whether to query ahead data from segments and feed it for data loading. **NOTE: **This configuration is disabled by default as it needs extra resources for querying extra data.Based on the memory availability on the cluster, user can enable it to improve compaction performance.</td>
</tr>
<tr>
<td>carbon.merge.index.in.segment</td>
<td>true</td>
-<td>Each CarbonData file has a companion CarbonIndex file which maintains the metadata about the data.These CarbonIndex files are read and loaded into driver and is used subsequently for pruning of data during queries.These CarbonIndex files are very small in size(few KB) and are many.Reading many small files from HDFS is not efficient and leads to slow IO performance.Hence these CarbonIndex files belonging to a segment can be combined into a single file and read once there by increasing the IO throughput.This configuration enables to merge all the CarbonIndex files into a single MergeIndex file upon data loading completion.<strong>NOTE:</strong> Reading a single big file is more efficient in HDFS and IO throughput is very high.Due to this the time needed to load the index files into memory when query is received for the first time on that table is significantly reduced and there by significantly reduces the delay in serving the first query.</td>
+<td>Each CarbonData file has a companion CarbonIndex file which maintains the metadata about the data. These CarbonIndex files are read and loaded into driver and is used subsequently for pruning of data during queries. These CarbonIndex files are very small in size(few KB) and are many.Reading many small files from HDFS is not efficient and leads to slow IO performance.Hence these CarbonIndex files belonging to a segment can be combined into a single file and read once there by increasing the IO throughput. This configuration enables to merge all the CarbonIndex files into a single MergeIndex file upon data loading completion.<strong>NOTE:</strong> Reading a single big file is more efficient in HDFS and IO throughput is very high.Due to this the time needed to load the index files into memory when query is received for the first time on that table is significantly reduced and there by significantly reduces the delay in serving the first query.</td>
</tr>
</tbody>
</table>
@@ -628,12 +651,12 @@
<tr>
<td>carbon.max.driver.lru.cache.size</td>
<td>-1</td>
-<td>Maximum memory <strong>(in MB)</strong> upto which the driver process can cache the data (BTree and dictionary values). Beyond this, least recently used data will be removed from cache before loading new set of values.Default value of -1 means there is no memory limit for caching. Only integer values greater than 0 are accepted.<strong>NOTE:</strong> Minimum number of entries that needs to be removed from cache in order to load the new set of data is determined and unloaded.ie.,for example if 3 cache entries qualify for pre-emption, out of these, those entries that free up more cache memory is removed prior to others.</td>
+<td>Maximum memory <strong>(in MB)</strong> upto which the driver process can cache the data (BTree and dictionary values). Beyond this, least recently used data will be removed from cache before loading new set of values.Default value of -1 means there is no memory limit for caching. Only integer values greater than 0 are accepted. <strong>NOTE:</strong> Minimum number of entries that needs to be removed from cache in order to load the new set of data is determined and unloaded.ie.,for example if 3 cache entries qualify for pre-emption, out of these, those entries that free up more cache memory is removed prior to others. Please refer <a href="./faq.html#how-to-check-lru-cache-memory-footprint">FAQs</a> for checking LRU cache memory footprint.</td>
</tr>
<tr>
<td>carbon.max.executor.lru.cache.size</td>
<td>-1</td>
-<td>Maximum memory <strong>(in MB)</strong> upto which the executor process can cache the data (BTree and reverse dictionary values).Default value of -1 means there is no memory limit for caching. Only integer values greater than 0 are accepted.<strong>NOTE:</strong> If this parameter is not configured, then the value of <em><strong>carbon.max.driver.lru.cache.size</strong></em> will be used.</td>
+<td>Maximum memory <strong>(in MB)</strong> upto which the executor process can cache the data (BTree and reverse dictionary values).Default value of -1 means there is no memory limit for caching. Only integer values greater than 0 are accepted. <strong>NOTE:</strong> If this parameter is not configured, then the value of <em><strong>carbon.max.driver.lru.cache.size</strong></em> will be used.</td>
</tr>
<tr>
<td>max.query.execution.time</td>
@@ -643,17 +666,17 @@
<tr>
<td>carbon.enableMinMax</td>
<td>true</td>
-<td>CarbonData maintains the metadata which enables to prune unnecessary files from being scanned as per the query conditions.To achieve pruning, Min,Max of each column is maintined.Based on the filter condition in the query, certain data can be skipped from scanning by matching the filter value against the min,max values of the column(s) present in that carbondata file.This pruing enhances query performance significantly.</td>
+<td>CarbonData maintains the metadata which enables to prune unnecessary files from being scanned as per the query conditions. To achieve pruning, Min,Max of each column is maintined.Based on the filter condition in the query, certain data can be skipped from scanning by matching the filter value against the min,max values of the column(s) present in that carbondata file. This pruning enhances query performance significantly.</td>
</tr>
<tr>
<td>carbon.dynamicallocation.schedulertimeout</td>
<td>5</td>
-<td>CarbonData has its own scheduling algorithm to suggest to Spark on how many tasks needs to be launched and how much work each task need to do in a Spark cluster for any query on CarbonData.To determine the number of tasks that can be scheduled, knowing the count of active executors is necessary.When dynamic allocation is enabled on a YARN based spark cluster,execuor processes are shutdown if no request is received for a particular amount of time.The executors are brought up when the requet is received again.This configuration specifies the maximum time (unit in seconds) the carbon scheduler can wait for executor to be active. Minimum value is 5 sec and maximum value is 15 sec.**NOTE: **Waiting for longer time leads to slow query response time.Moreover it might be possible that YARN is not able to start the executors and waiting is not beneficial.</td>
+<td>CarbonData has its own scheduling algorithm to suggest to Spark on how many tasks needs to be launched and how much work each task need to do in a Spark cluster for any query on CarbonData. To determine the number of tasks that can be scheduled, knowing the count of active executors is necessary. When dynamic allocation is enabled on a YARN based spark cluster, executor processes are shutdown if no request is received for a particular amount of time. The executors are brought up when the requet is received again. This configuration specifies the maximum time (unit in seconds) the carbon scheduler can wait for executor to be active. Minimum value is 5 sec and maximum value is 15 sec.**NOTE: **Waiting for longer time leads to slow query response time.Moreover it might be possible that YARN is not able to start the executors and waiting is not beneficial.</td>
</tr>
<tr>
<td>carbon.scheduler.minregisteredresourcesratio</td>
<td>0.8</td>
-<td>Specifies the minimum resource (executor) ratio needed for starting the block distribution. The default value is 0.8, which indicates 80% of the requested resource is allocated for starting block distribution. The minimum value is 0.1 min and the maximum value is 1.0.</td>
+<td>Specifies the minimum resource (executor) ratio needed for starting the block distribution. The default value is 0.8, which indicates 80% of the requested resource is allocated for starting block distribution. The minimum value is 0.1 min and the maximum value is 1.0.</td>
</tr>
<tr>
<td>carbon.search.enabled (Alpha Feature)</td>
@@ -663,7 +686,7 @@
<tr>
<td>carbon.search.query.timeout</td>
<td>10s</td>
-<td>Time within which the result is expected from the workers;beyond which the query is terminated</td>
+<td>Time within which the result is expected from the workers, beyond which the query is terminated</td>
</tr>
<tr>
<td>carbon.search.scan.thread</td>
@@ -694,7 +717,7 @@
<tr>
<td>carbon.enable.vector.reader</td>
<td>true</td>
-<td>Spark added vector processing to optimize cpu cache miss and there by increase the query performance.This configuration enables to fetch data as columnar batch of size 4*1024 rows instead of fetching data row by row and provide it to spark so that there is improvement in select queries performance.</td>
+<td>Spark added vector processing to optimize cpu cache miss and there by increase the query performance. This configuration enables to fetch data as columnar batch of size 4*1024 rows instead of fetching data row by row and provide it to spark so that there is improvement in select queries performance.</td>
</tr>
<tr>
<td>carbon.task.distribution</td>
@@ -704,27 +727,27 @@
<tr>
<td>carbon.custom.block.distribution</td>
<td>false</td>
-<td>CarbonData has its own scheduling algorithm to suggest to Spark on how many tasks needs to be launched and how much work each task need to do in a Spark cluster for any query on CarbonData.When this configuration is true, CarbonData would distribute the available blocks to be scanned among the available number of cores.For Example:If there are 10 blocks to be scanned and only 3 tasks can be run(only 3 executor cores available in the cluster), CarbonData would combine blocks as 4,3,3 and give it to 3 tasks to run.<strong>NOTE:</strong> When this configuration is false, as per the <em><strong>carbon.task.distribution</strong></em> configuration, each block/blocklet would be given to each task.</td>
+<td>CarbonData has its own scheduling algorithm to suggest to Spark on how many tasks needs to be launched and how much work each task need to do in a Spark cluster for any query on CarbonData. When this configuration is true, CarbonData would distribute the available blocks to be scanned among the available number of cores.For Example:If there are 10 blocks to be scanned and only 3 tasks can be run(only 3 executor cores available in the cluster), CarbonData would combine blocks as 4,3,3 and give it to 3 tasks to run. <strong>NOTE:</strong> When this configuration is false, as per the <em><strong>carbon.task.distribution</strong></em> configuration, each block/blocklet would be given to each task.</td>
</tr>
<tr>
<td>enable.query.statistics</td>
<td>false</td>
-<td>CarbonData has extensive logging which would be useful for debugging issues related to performance or hard to locate issues.This configuration when made <em><strong>true</strong></em> would log additional query statistics information to more accurately locate the issues being debugged.<strong>NOTE:</strong> Enabling this would log more debug information to log files, there by increasing the log files size significantly in short span of time.It is advised to configure the log files size, retention of log files parameters in log4j properties appropriately.Also extensive logging is an increased IO operation and hence over all query performance might get reduced.Therefore it is recommened to enable this configuration only for the duration of debugging.</td>
+<td>CarbonData has extensive logging which would be useful for debugging issues related to performance or hard to locate issues. This configuration when made <em><strong>true</strong></em> would log additional query statistics information to more accurately locate the issues being debugged.<strong>NOTE:</strong> Enabling this would log more debug information to log files, there by increasing the log files size significantly in short span of time.It is advised to configure the log files size, retention of log files parameters in log4j properties appropriately. Also extensive logging is an increased IO operation and hence over all query performance might get reduced. Therefore it is recommended to enable this configuration only for the duration of debugging.</td>
</tr>
<tr>
<td>enable.unsafe.in.query.processing</td>
-<td>true</td>
-<td>CarbonData supports unsafe operations of Java to avoid GC overhead for certain operations.This configuration enables to use unsafe functions in CarbonData while scanning the data during query.</td>
+<td>false</td>
+<td>CarbonData supports unsafe operations of Java to avoid GC overhead for certain operations. This configuration enables to use unsafe functions in CarbonData while scanning the data during query.</td>
</tr>
<tr>
<td>carbon.query.validate.directqueryondatamap</td>
<td>true</td>
-<td>CarbonData supports creating pre-aggregate table datamaps as an independent tables.For some debugging purposes, it might be required to directly query from such datamap tables.This configuration allows to query on such datamaps.</td>
+<td>CarbonData supports creating pre-aggregate table datamaps as an independent tables. For some debugging purposes, it might be required to directly query from such datamap tables. This configuration allows to query on such datamaps.</td>
</tr>
<tr>
<td>carbon.heap.memory.pooling.threshold.bytes</td>
<td>1048576</td>
-<td>CarbonData supports unsafe operations of Java to avoid GC overhead for certain operations.Using unsafe, memory can be allocated on Java Heap or off heap.This configuration controlls the allocation mechanism on Java HEAP.If the heap memory allocations of the given size is greater or equal than this value,it should go through the pooling mechanism.But if set this size to -1, it should not go through the pooling mechanism.Default value is 1048576(1MB, the same as Spark).Value to be specified in bytes.</td>
+<td>CarbonData supports unsafe operations of Java to avoid GC overhead for certain operations. Using unsafe, memory can be allocated on Java Heap or off heap. This configuration controls the allocation mechanism on Java HEAP.If the heap memory allocations of the given size is greater or equal than this value,it should go through the pooling mechanism.But if set this size to -1, it should not go through the pooling mechanism.Default value is 1048576(1MB, the same as Spark).Value to be specified in bytes.</td>
</tr>
</tbody>
</table>
@@ -747,7 +770,7 @@
<tr>
<td>carbon.insert.storage.level</td>
<td>MEMORY_AND_DISK</td>
-<td>Storage level to persist dataset of a RDD/dataframe.Applicable when <em><strong>carbon.insert.persist.enable</strong></em> is <strong>true</strong>, if user's executor has less memory, set this parameter to 'MEMORY_AND_DISK_SER' or other storage level to correspond to different environment. <a href="http://spark.apache.org/docs/latest/rdd-programming-guide.html#rdd-persistence" rel="nofollow">See detail</a>.</td>
+<td>Storage level to persist dataset of a RDD/dataframe. Applicable when <em><strong>carbon.insert.persist.enable</strong></em> is <strong>true</strong>, if user's executor has less memory, set this parameter to 'MEMORY_AND_DISK_SER' or other storage level to correspond to different environment. <a href="http://spark.apache.org/docs/latest/rdd-programming-guide.html#rdd-persistence" rel="nofollow">See detail</a>.</td>
</tr>
<tr>
<td>carbon.update.persist.enable</td>
@@ -757,7 +780,7 @@
<tr>
<td>carbon.update.storage.level</td>
<td>MEMORY_AND_DISK</td>
-<td>Storage level to persist dataset of a RDD/dataframe.Applicable when <em><strong>carbon.update.persist.enable</strong></em> is <strong>true</strong>, if user's executor has less memory, set this parameter to 'MEMORY_AND_DISK_SER' or other storage level to correspond to different environment. <a href="http://spark.apache.org/docs/latest/rdd-programming-guide.html#rdd-persistence" rel="nofollow">See detail</a>.</td>
+<td>Storage level to persist dataset of a RDD/dataframe. Applicable when <em><strong>carbon.update.persist.enable</strong></em> is <strong>true</strong>, if user's executor has less memory, set this parameter to 'MEMORY_AND_DISK_SER' or other storage level to correspond to different environment. <a href="http://spark.apache.org/docs/latest/rdd-programming-guide.html#rdd-persistence" rel="nofollow">See detail</a>.</td>
</tr>
</tbody>
</table>
@@ -821,7 +844,7 @@
<tbody>
<tr>
<td>carbon.options.bad.records.logger.enable</td>
-<td>CarbonData can identify the records that are not conformant to schema and isolate them as bad records.Enabling this configuration will make CarbonData to log such bad records.<strong>NOTE:</strong> If the input data contains many bad records, logging them will slow down the over all data loading throughput.The data load operation status would depend on the configuration in <em><strong>carbon.bad.records.action</strong></em>.</td>
+<td>CarbonData can identify the records that are not conformant to schema and isolate them as bad records.Enabling this configuration will make CarbonData to log such bad records.<strong>NOTE:</strong> If the input data contains many bad records, logging them will slow down the over all data loading throughput. The data load operation status would depend on the configuration in <em><strong>carbon.bad.records.action</strong></em>.</td>
</tr>
<tr>
<td>carbon.options.bad.records.logger.enable</td>
@@ -841,7 +864,7 @@
</tr>
<tr>
<td>carbon.options.single.pass</td>
-<td>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. This option specifies whether to use single pass for loading data or not. By default this option is set to FALSE.<strong>NOTE:</strong> Enabling this starts a new dictionary server to handle dictionary generation requests during data loading.Without this option, the input csv files will have to read twice.Once while dictionary generation and persisting to the dictionary files.second when the data loading need to convert the input data into carbondata format.Enabling this optimizes the optimizes to read the input data only once there by reducing IO and hence over all data loading time.If concurrent data loading needs to be supported, consider tuning <em><strong>dictionary.worker.threads</strong></em>.Port on w
<TRUNCATED>
[11/20] carbondata-site git commit: modified for 1.5.0 version
Posted by ch...@apache.org.
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)
[12/20] carbondata-site git commit: modified for 1.5.0 version
Posted by ch...@apache.org.
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>