Skip to content

Commit

Permalink
add doc
Browse files Browse the repository at this point in the history
  • Loading branch information
xubo245 committed Nov 20, 2018
1 parent 1d5246d commit 025f6bf
Show file tree
Hide file tree
Showing 3 changed files with 56 additions and 17 deletions.
30 changes: 30 additions & 0 deletions docs/csdk-guide.md
Expand Up @@ -241,6 +241,36 @@ release the memory and destroy JVM.
jobject readSchema(char *path, bool validateSchema);
```

```
/**
* read schema from path,
* path can be folder path, carbonindex file path, and carbondata file path
* and will not check all files schema
*
* @param path file/folder path
* @param conf configuration support, can set s3a AK,SK,
* end point and other conf with this
* @return schema
*/
jobject readSchema(char *path, Configuration conf);
```

```
/**
* read schema from path,
* path can be folder path, carbonindex file path, and carbondata file path
* and user can decide whether check all files schema
*
* @param path carbon data path
* @param validateSchema whether check all files schema
* @param conf configuration support, can set s3a AK,SK,
* end point and other conf with this
* @return schema
*/
jobject readSchema(char *path, bool validateSchema, Configuration conf);
```

###Schema
```
/**
Expand Down
41 changes: 26 additions & 15 deletions docs/sdk-guide.md
Expand Up @@ -633,7 +633,7 @@ Find example code at [CarbonReaderExample](https://github.com/apache/carbondata/
* @return list of CarbonReader objects
*/
public List<CarbonReader> split(int maxSplits);
``
```

```
/**
Expand Down Expand Up @@ -722,48 +722,59 @@ Find example code at [CarbonReaderExample](https://github.com/apache/carbondata/

```
/**
* Read carbondata file and return the schema
* read schema from path,
* path can be folder path,carbonindex file path, and carbondata file path
* and will not check all files schema
*
* @param dataFilePath complete path including carbondata file name
* @return Schema object
* @param path file/folder path
* @return schema
* @throws IOException
*/
public static Schema readSchemaInDataFile(String dataFilePath);
public static Schema readSchema(String path);
```

```
/**
* Read carbonindex file and return the schema
* read schema from path,
* path can be folder path, carbonindex file path, and carbondata file path
* and will not check all files schema
*
* @param indexFilePath complete path including index file name
* @return schema object
* @param path file/folder path
* @param conf hadoop configuration support, can set s3a AK,SK,end point and other conf with this
* @return schema
* @throws IOException
*/
public static Schema readSchemaInIndexFile(String indexFilePath);
public static Schema readSchema(String path, Configuration conf);
```

```
/**
* read schema from path,
* path can be folder path,carbonindex file path, and carbondata file path
* and will not check all files schema
* and user can decide whether check all files schema
*
* @param path file/folder path
* @param path file/folder path
* @param validateSchema whether check all files schema
* @return schema
* @throws IOException
*/
public static Schema readSchema(String path);
public static Schema readSchema(String path, boolean validateSchema);
```

```
/**
* read schema from path,
* path can be folder path,carbonindex file path, and carbondata file path
* path can be folder path, carbonindex file path, and carbondata file path
* and user can decide whether check all files schema
*
* @param path file/folder path
* @param path file/folder path
* @param validateSchema whether check all files schema
* @param conf hadoop configuration support, can set s3a AK,SK,
* end point and other conf with this
* @return schema
* @throws IOException
*/
public static Schema readSchema(String path, boolean validateSchema);
public static Schema readSchema(String path, boolean validateSchema, Configuration conf);
```

```
Expand Down
Expand Up @@ -49,8 +49,6 @@
*/
public class CarbonSchemaReader {

private Configuration hadoopConf;

/**
* Read schema file and return the schema
*
Expand Down

0 comments on commit 025f6bf

Please sign in to comment.