Repository: carbondata-site Updated Branches: refs/heads/asf-site f3305fbb1 -> 0e4aec4a1
fixed issue with content Project: http://git-wip-us.apache.org/repos/asf/carbondata-site/repo Commit: http://git-wip-us.apache.org/repos/asf/carbondata-site/commit/acd4dd28 Tree: http://git-wip-us.apache.org/repos/asf/carbondata-site/tree/acd4dd28 Diff: http://git-wip-us.apache.org/repos/asf/carbondata-site/diff/acd4dd28 Branch: refs/heads/asf-site Commit: acd4dd2895995d67876b7748fb03e33600e9202a Parents: f3305fb Author: vandana7 <[email protected]> Authored: Tue Jun 5 14:25:02 2018 +0530 Committer: vandana7 <[email protected]> Committed: Tue Jun 5 14:25:02 2018 +0530 ---------------------------------------------------------------------- content/mainpage.html | 9 +- content/pdf/CarbonData Documentation.pdf | Bin 292327 -> 293342 bytes content/sdk-guide.html | 78 +++++++-------- src/main/webapp/mainpage.html | 3 +- .../webapp/pdf/CarbonData Documentation.pdf | Bin 292327 -> 293342 bytes src/main/webapp/sdk-guide.html | 78 +++++++-------- src/site/markdown/sdk-guide.md | 95 ++++++++++--------- 7 files changed, 134 insertions(+), 129 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/acd4dd28/content/mainpage.html ---------------------------------------------------------------------- diff --git a/content/mainpage.html b/content/mainpage.html index d2746db..259d485 100644 --- a/content/mainpage.html +++ b/content/mainpage.html @@ -197,16 +197,15 @@ <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 Writer Guide</a></li> + <li><a href="sdk-guide.html">SDK Guide</a></li> <li><a href="datamap-developer-guide.html">DataMap Developer Guide</a></li> - <li><a href="bloomfilter-datamap-guide.html">CarbonData Pre-aggregate DataMap</a></li> - <li><a href="lucene-datamap-guide.html">CarbonData Pre-aggregate DataMap</a></li> + <li><a href="bloomfilter-datamap-guide.html">CarbonData BloomFilter DataMap (Alpha feature in 1.4.0)</a></li> + <li><a href="lucene-datamap-guide.html">CarbonData Lucene DataMap (Alpha feature in 1.4.0)</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> + <li><a href="useful-tips-on-carbondata.html">Useful Tips</a></li> </ul> </div> http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/acd4dd28/content/pdf/CarbonData Documentation.pdf ---------------------------------------------------------------------- diff --git a/content/pdf/CarbonData Documentation.pdf b/content/pdf/CarbonData Documentation.pdf index a557cca..c4d389d 100644 Binary files a/content/pdf/CarbonData Documentation.pdf and b/content/pdf/CarbonData Documentation.pdf differ http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/acd4dd28/content/sdk-guide.html ---------------------------------------------------------------------- diff --git a/content/sdk-guide.html b/content/sdk-guide.html index 7128c6c..d980f83 100644 --- a/content/sdk-guide.html +++ b/content/sdk-guide.html @@ -529,44 +529,6 @@ public Schema(Field[] fields); public static Schema parseJson(String json); </code></pre> <h3> -<a id="class-orgapachecarbondatacoreutilcarbonproperties" class="anchor" href="#class-orgapachecarbondatacoreutilcarbonproperties" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Class org.apache.carbondata.core.util.CarbonProperties</h3> -<pre><code>/** -* This method will be responsible to get the instance of CarbonProperties class -* -* @return carbon properties instance -*/ -public static CarbonProperties getInstance(); -</code></pre> -<pre><code>/** -* This method will be used to add a new property -* -* @param key is a property name to set for carbon. -* @param value is valid parameter corresponding to property. -* @return CarbonProperties object -*/ -public CarbonProperties addProperty(String key, String value); -</code></pre> -<pre><code>/** -* This method will be used to get the property value. If property is not -* present, then it will return the default value. -* -* @param key is a property name to get user specified value. -* @return properties value for corresponding key. If not set, then returns null. -*/ -public String getProperty(String key); -</code></pre> -<pre><code>/** -* This method will be used to get the property value. If property is not -* present, then it will return the default value. -* -* @param key is a property name to get user specified value.. -* @param defaultValue used to be returned by function if corrosponding key not set. -* @return properties value for corresponding key. If not set, then returns specified defaultValue. -*/ -public String getProperty(String key, String defaultValue); -</code></pre> -<p>Reference : <a href="http://carbondata.apache.org/configuration-parameters.html"; target=_blank rel="nofollow">list of carbon properties</a></p> -<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 @@ -828,6 +790,46 @@ External client can make use of this reader to read CarbonData files without Car public Field(ColumnSchema columnSchema); </code></pre> <p>Find S3 example code at <a href="https://github.com/apache/carbondata/blob/master/examples/spark2/src/main/java/org/apache/carbondata/examples/sdk/SDKS3Example.java"; target=_blank>SDKS3Example</a> in the CarbonData repo.</p> +<h1> +<a id="common-api-list-for-carbonreader-and-carbonwriter" class="anchor" href="#common-api-list-for-carbonreader-and-carbonwriter" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Common API List for CarbonReader and CarbonWriter</h1> +<h3> +<a id="class-orgapachecarbondatacoreutilcarbonproperties" class="anchor" href="#class-orgapachecarbondatacoreutilcarbonproperties" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Class org.apache.carbondata.core.util.CarbonProperties</h3> +<pre><code>/** +* This method will be responsible to get the instance of CarbonProperties class +* +* @return carbon properties instance +*/ +public static CarbonProperties getInstance(); +</code></pre> +<pre><code>/** +* This method will be used to add a new property +* +* @param key is a property name to set for carbon. +* @param value is valid parameter corresponding to property. +* @return CarbonProperties object +*/ +public CarbonProperties addProperty(String key, String value); +</code></pre> +<pre><code>/** +* This method will be used to get the property value. If property is not +* present, then it will return the default value. +* +* @param key is a property name to get user specified value. +* @return properties value for corresponding key. If not set, then returns null. +*/ +public String getProperty(String key); +</code></pre> +<pre><code>/** +* This method will be used to get the property value. If property is not +* present, then it will return the default value. +* +* @param key is a property name to get user specified value.. +* @param defaultValue used to be returned by function if corrosponding key not set. +* @return properties value for corresponding key. If not set, then returns specified defaultValue. +*/ +public String getProperty(String key, String defaultValue); +</code></pre> +<p>Reference : <a href="http://carbondata.apache.org/configuration-parameters.html"; target=_blank rel="nofollow">list of carbon properties</a></p> </div> </div> </div> http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/acd4dd28/src/main/webapp/mainpage.html ---------------------------------------------------------------------- diff --git a/src/main/webapp/mainpage.html b/src/main/webapp/mainpage.html index 39abe9b..259d485 100644 --- a/src/main/webapp/mainpage.html +++ b/src/main/webapp/mainpage.html @@ -205,8 +205,7 @@ <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> + <li><a href="useful-tips-on-carbondata.html">Useful Tips</a></li> </ul> </div> http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/acd4dd28/src/main/webapp/pdf/CarbonData Documentation.pdf ---------------------------------------------------------------------- diff --git a/src/main/webapp/pdf/CarbonData Documentation.pdf b/src/main/webapp/pdf/CarbonData Documentation.pdf index a557cca..c4d389d 100644 Binary files a/src/main/webapp/pdf/CarbonData Documentation.pdf and b/src/main/webapp/pdf/CarbonData Documentation.pdf differ http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/acd4dd28/src/main/webapp/sdk-guide.html ---------------------------------------------------------------------- diff --git a/src/main/webapp/sdk-guide.html b/src/main/webapp/sdk-guide.html index 7128c6c..d980f83 100644 --- a/src/main/webapp/sdk-guide.html +++ b/src/main/webapp/sdk-guide.html @@ -529,44 +529,6 @@ public Schema(Field[] fields); public static Schema parseJson(String json); </code></pre> <h3> -<a id="class-orgapachecarbondatacoreutilcarbonproperties" class="anchor" href="#class-orgapachecarbondatacoreutilcarbonproperties" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Class org.apache.carbondata.core.util.CarbonProperties</h3> -<pre><code>/** -* This method will be responsible to get the instance of CarbonProperties class -* -* @return carbon properties instance -*/ -public static CarbonProperties getInstance(); -</code></pre> -<pre><code>/** -* This method will be used to add a new property -* -* @param key is a property name to set for carbon. -* @param value is valid parameter corresponding to property. -* @return CarbonProperties object -*/ -public CarbonProperties addProperty(String key, String value); -</code></pre> -<pre><code>/** -* This method will be used to get the property value. If property is not -* present, then it will return the default value. -* -* @param key is a property name to get user specified value. -* @return properties value for corresponding key. If not set, then returns null. -*/ -public String getProperty(String key); -</code></pre> -<pre><code>/** -* This method will be used to get the property value. If property is not -* present, then it will return the default value. -* -* @param key is a property name to get user specified value.. -* @param defaultValue used to be returned by function if corrosponding key not set. -* @return properties value for corresponding key. If not set, then returns specified defaultValue. -*/ -public String getProperty(String key, String defaultValue); -</code></pre> -<p>Reference : <a href="http://carbondata.apache.org/configuration-parameters.html"; target=_blank rel="nofollow">list of carbon properties</a></p> -<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 @@ -828,6 +790,46 @@ External client can make use of this reader to read CarbonData files without Car public Field(ColumnSchema columnSchema); </code></pre> <p>Find S3 example code at <a href="https://github.com/apache/carbondata/blob/master/examples/spark2/src/main/java/org/apache/carbondata/examples/sdk/SDKS3Example.java"; target=_blank>SDKS3Example</a> in the CarbonData repo.</p> +<h1> +<a id="common-api-list-for-carbonreader-and-carbonwriter" class="anchor" href="#common-api-list-for-carbonreader-and-carbonwriter" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Common API List for CarbonReader and CarbonWriter</h1> +<h3> +<a id="class-orgapachecarbondatacoreutilcarbonproperties" class="anchor" href="#class-orgapachecarbondatacoreutilcarbonproperties" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Class org.apache.carbondata.core.util.CarbonProperties</h3> +<pre><code>/** +* This method will be responsible to get the instance of CarbonProperties class +* +* @return carbon properties instance +*/ +public static CarbonProperties getInstance(); +</code></pre> +<pre><code>/** +* This method will be used to add a new property +* +* @param key is a property name to set for carbon. +* @param value is valid parameter corresponding to property. +* @return CarbonProperties object +*/ +public CarbonProperties addProperty(String key, String value); +</code></pre> +<pre><code>/** +* This method will be used to get the property value. If property is not +* present, then it will return the default value. +* +* @param key is a property name to get user specified value. +* @return properties value for corresponding key. If not set, then returns null. +*/ +public String getProperty(String key); +</code></pre> +<pre><code>/** +* This method will be used to get the property value. If property is not +* present, then it will return the default value. +* +* @param key is a property name to get user specified value.. +* @param defaultValue used to be returned by function if corrosponding key not set. +* @return properties value for corresponding key. If not set, then returns specified defaultValue. +*/ +public String getProperty(String key, String defaultValue); +</code></pre> +<p>Reference : <a href="http://carbondata.apache.org/configuration-parameters.html"; target=_blank rel="nofollow">list of carbon properties</a></p> </div> </div> </div> http://git-wip-us.apache.org/repos/asf/carbondata-site/blob/acd4dd28/src/site/markdown/sdk-guide.md ---------------------------------------------------------------------- diff --git a/src/site/markdown/sdk-guide.md b/src/site/markdown/sdk-guide.md index 2371b33..5dbb5ac 100644 --- a/src/site/markdown/sdk-guide.md +++ b/src/site/markdown/sdk-guide.md @@ -350,52 +350,6 @@ public Schema(Field[] fields); public static Schema parseJson(String json); ``` -### Class org.apache.carbondata.core.util.CarbonProperties - -``` -/** -* This method will be responsible to get the instance of CarbonProperties class -* -* @return carbon properties instance -*/ -public static CarbonProperties getInstance(); -``` - -``` -/** -* This method will be used to add a new property -* -* @param key is a property name to set for carbon. -* @param value is valid parameter corresponding to property. -* @return CarbonProperties object -*/ -public CarbonProperties addProperty(String key, String value); -``` - -``` -/** -* This method will be used to get the property value. If property is not -* present, then it will return the default value. -* -* @param key is a property name to get user specified value. -* @return properties value for corresponding key. If not set, then returns null. -*/ -public String getProperty(String key); -``` - -``` -/** -* This method will be used to get the property value. If property is not -* present, then it will return the default value. -* -* @param key is a property name to get user specified value.. -* @param defaultValue used to be returned by function if corrosponding key not set. -* @return properties value for corresponding key. If not set, then returns specified defaultValue. -*/ -public String getProperty(String key, String defaultValue); -``` -Reference : [list of carbon properties](http://carbondata.apache.org/configuration-parameters.html) - ### Class org.apache.carbondata.sdk.file.AvroCarbonWriter ``` /** @@ -705,3 +659,52 @@ Find example code at [CarbonReaderExample](https://github.com/apache/carbondata/ ``` Find S3 example code at [SDKS3Example](https://github.com/apache/carbondata/blob/master/examples/spark2/src/main/java/org/apache/carbondata/examples/sdk/SDKS3Example.java) in the CarbonData repo. + + +# Common API List for CarbonReader and CarbonWriter + +### Class org.apache.carbondata.core.util.CarbonProperties + +``` +/** +* This method will be responsible to get the instance of CarbonProperties class +* +* @return carbon properties instance +*/ +public static CarbonProperties getInstance(); +``` + +``` +/** +* This method will be used to add a new property +* +* @param key is a property name to set for carbon. +* @param value is valid parameter corresponding to property. +* @return CarbonProperties object +*/ +public CarbonProperties addProperty(String key, String value); +``` + +``` +/** +* This method will be used to get the property value. If property is not +* present, then it will return the default value. +* +* @param key is a property name to get user specified value. +* @return properties value for corresponding key. If not set, then returns null. +*/ +public String getProperty(String key); +``` + +``` +/** +* This method will be used to get the property value. If property is not +* present, then it will return the default value. +* +* @param key is a property name to get user specified value.. +* @param defaultValue used to be returned by function if corrosponding key not set. +* @return properties value for corresponding key. If not set, then returns specified defaultValue. +*/ +public String getProperty(String key, String defaultValue); +``` +Reference : [list of carbon properties](http://carbondata.apache.org/configuration-parameters.html)
