jgutmann commented on a change in pull request #3975: ReadTheDocs documentation for Table Configs, Monitoring, and Deployment URL: https://github.com/apache/incubator-pinot/pull/3975#discussion_r268323095
########## File path: docs/tableconfig_schema.rst ########## @@ -0,0 +1,204 @@ +.. +.. 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. +.. + +Table Config +============ + +Table Config +------------- + +Introduction +~~~~~~~~~~~~ + +Using tables is how Pinot serves and organizes data. There are many settings in the table config which will influence how Pinot operates. The first and most significant distinction is using an offline versus a realtime table. + +An offline table in Pinot is used to host data which might be periodically uploaded - daily, weekly, etc. A realtime table, however, is used to consume data from incoming data streams and serve this data in a near-realtime manner. This might also be referred to as nearline or just plain 'realtime'. + +In this section a sample table configuration will be shown and all sections will be explained and if applicable have appropriate sections linked to for further explanation of those corresponding Pinot features. + +Sample table config and descriptions +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +A sample table config is shown below which has sub-sections collasped. The sub sections will be described individually in following sections. Review comment: xajiang [12:48 PM] You can check `TableConfig.validate()` method ```public void validate() { Preconditions.checkState(_tableName != null, "Table name is missing"); Preconditions.checkState(_tableType != null, "Table type is missing"); Preconditions.checkState(_validationConfig != null, "Validation config is missing"); Preconditions.checkState(_tenantConfig != null, "Tenant config is missing"); Preconditions.checkState(_indexingConfig != null, "Indexing config is missing"); Preconditions.checkState(_customConfig != null, "Custom config is missing"); }``` xajiang [12:51 PM] ```public static final String TABLE_NAME_KEY = "tableName"; public static final String TABLE_TYPE_KEY = "tableType"; public static final String VALIDATION_CONFIG_KEY = "segmentsConfig"; public static final String TENANT_CONFIG_KEY = "tenants"; public static final String INDEXING_CONFIG_KEY = "tableIndexConfig"; public static final String CUSTOM_CONFIG_KEY = "metadata";``` ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected] With regards, Apache Git Services --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
