cloudflare/ClickHouse
Publicmirrored fromhttps://github.com/cloudflare/ClickHouse
docs/mkdocs_en.yml
254lines · modecode
8 years ago
| 1 | site_name: ClickHouse Documentation |
| 2 | copyright: ©2016–2018 Yandex LLC |
| 3 | |
| 4 | docs_dir: en |
| 5 | site_dir: build/docs/en |
| 6 | use_directory_urls: true |
| 7 | |
| 8 | repo_name: 'yandex/ClickHouse' |
| 9 | repo_url: 'https://github.com/yandex/ClickHouse/' |
| 10 | edit_uri: 'edit/master/docs/en' |
| 11 | |
| 12 | extra_css: |
| 13 | - assets/stylesheets/custom.css |
| 14 | |
| 15 | |
| 16 | markdown_extensions: |
| 17 | - codehilite |
| 18 | |
| 19 | theme: |
| 20 | name: null |
| 21 | custom_dir: 'mkdocs-material-theme' |
| 22 | language: 'en' |
| 23 | feature: |
| 24 | tabs: false |
| 25 | palette: |
| 26 | primary: 'white' |
| 27 | accent: 'white' |
| 28 | font: false |
| 29 | logo: 'images/logo.svg' |
| 30 | favicon: 'assets/images/favicon.ico' |
| 31 | include_search_page: false |
| 32 | search_index_only: true |
| 33 | static_templates: |
| 34 | - 404.html |
| 35 | |
| 36 | extra: |
| 37 | single_page: false |
| 38 | search: |
| 39 | language: 'en' |
| 40 | |
| 41 | pages: |
| 42 | - 'ClickHouse': 'index.md' |
| 43 | |
| 44 | - 'Introduction': |
| 45 | # - 'Введение': 'introduction/index.md' |
| 46 | - 'Distinctive features of ClickHouse': 'introduction/distinctive_features.md' |
| 47 | - 'ClickHouse features that can be considered disadvantages': 'introduction/features_considered_disadvantages.md' |
| 48 | - 'The Yandex.Metrica task': 'introduction/ya_metrika_task.md' |
| 49 | - 'Everything you were afraid to ask': 'introduction/possible_silly_questions.md' |
| 50 | - 'Performance': 'introduction/performance.md' |
| 51 | |
| 52 | - 'Getting started': |
| 53 | - 'Deploying and running': 'getting_started/index.md' |
| 54 | - 'Testing data': |
| 55 | - 'OnTime': 'getting_started/example_datasets/ontime.md' |
| 56 | - 'New York Taxi data': 'getting_started/example_datasets/nyc_taxi.md' |
| 57 | - 'AMPLab Big Data Benchmark': 'getting_started/example_datasets/amplab_benchmark.md' |
| 58 | - 'WikiStat': 'getting_started/example_datasets/wikistat.md' |
| 59 | - 'Terabyte click logs from Criteo': 'getting_started/example_datasets/criteo.md' |
| 60 | - 'Star Schema Benchmark': 'getting_started/example_datasets/star_schema.md' |
| 61 | |
| 62 | - 'Interfaces': |
| 63 | - 'Introduction': 'interfaces/index.md' |
| 64 | - 'Command-line client': 'interfaces/cli.md' |
| 65 | - 'HTTP interface': 'interfaces/http_interface.md' |
| 66 | - 'JDBC driver': 'interfaces/jdbc.md' |
| 67 | - 'Native interface (TCP)': 'interfaces/tcp.md' |
| 68 | - 'Libraries from third-party developers': 'interfaces/third-party_client_libraries.md' |
| 69 | - 'Visual interfaces from third-party developers': 'interfaces/third-party_gui.md' |
| 70 | |
| 71 | - 'Query language': |
| 72 | # - 'Query language': 'query_language/index.md' |
| 73 | - 'Queries': 'query_language/queries.md' |
| 74 | - 'Syntax': 'query_language/syntax.md' |
| 75 | |
| 76 | - 'Table engines': |
| 77 | - 'Introduction': 'table_engines/index.md' |
| 78 | - 'TinyLog': 'table_engines/tinylog.md' |
| 79 | - 'Log': 'table_engines/log.md' |
| 80 | - 'Memory': 'table_engines/memory.md' |
| 81 | - 'MergeTree': 'table_engines/mergetree.md' |
| 82 | - 'Custom partitioning key': 'table_engines/custom_partitioning_key.md' |
| 83 | - 'ReplacingMergeTree': 'table_engines/replacingmergetree.md' |
| 84 | - 'SummingMergeTree': 'table_engines/summingmergetree.md' |
| 85 | - 'AggregatingMergeTree': 'table_engines/aggregatingmergetree.md' |
| 86 | - 'CollapsingMergeTree': 'table_engines/collapsingmergetree.md' |
| 87 | - 'GraphiteMergeTree': 'table_engines/graphitemergetree.md' |
| 88 | - 'Data replication': 'table_engines/replication.md' |
| 89 | - 'Distributed': 'table_engines/distributed.md' |
| 90 | - 'Dictionary': 'table_engines/dictionary.md' |
| 91 | - 'Merge': 'table_engines/merge.md' |
| 92 | - 'Buffer': 'table_engines/buffer.md' |
| 93 | - 'File': 'table_engines/file.md' |
| 94 | - 'Null': 'table_engines/null.md' |
| 95 | - 'Set': 'table_engines/set.md' |
| 96 | - 'Join': 'table_engines/join.md' |
| 97 | - 'View': 'table_engines/view.md' |
| 98 | - 'MaterializedView': 'table_engines/materializedview.md' |
| 99 | - 'Kafka': 'table_engines/kafka.md' |
| 100 | - 'MySQL': 'table_engines/mysql.md' |
| 101 | - 'External data for query processing': 'table_engines/external_data.md' |
| 102 | |
| 103 | - 'System tables': |
| 104 | - 'Introduction': 'system_tables/index.md' |
| 105 | - 'system.one': 'system_tables/system.one.md' |
| 106 | - 'system.numbers': 'system_tables/system.numbers.md' |
| 107 | - 'system.numbers_mt': 'system_tables/system.numbers_mt.md' |
| 108 | - 'system.databases': 'system_tables/system.databases.md' |
| 109 | - 'system.tables': 'system_tables/system.tables.md' |
| 110 | - 'system.columns': 'system_tables/system.columns.md' |
| 111 | - 'system.parts': 'system_tables/system.parts.md' |
| 112 | - 'system.processes': 'system_tables/system.processes.md' |
| 113 | - 'system.merges': 'system_tables/system.merges.md' |
| 114 | - 'system.events': 'system_tables/system.events.md' |
| 115 | - 'system.metrics': 'system_tables/system.metrics.md' |
| 116 | - 'system.asynchronous_metrics': 'system_tables/system.asynchronous_metrics.md' |
| 117 | - 'system.replicas': 'system_tables/system.replicas.md' |
| 118 | - 'system.dictionaries': 'system_tables/system.dictionaries.md' |
| 119 | - 'system.clusters': 'system_tables/system.clusters.md' |
| 120 | - 'system.functions': 'system_tables/system.functions.md' |
| 121 | - 'system.settings': 'system_tables/system.settings.md' |
| 122 | - 'system.zookeeper': 'system_tables/system.zookeeper.md' |
| 123 | |
| 124 | - 'Table functions': |
| 125 | - 'Introduction': 'table_functions/index.md' |
| 126 | - 'file': 'table_functions/file.md' |
| 127 | - 'merge': 'table_functions/merge.md' |
| 128 | - 'numbers': 'table_functions/numbers.md' |
| 129 | - 'remote': 'table_functions/remote.md' |
| 130 | |
| 131 | - 'Formats': |
| 132 | - 'Introduction': 'formats/index.md' |
| 133 | - 'TabSeparated': 'formats/tabseparated.md' |
| 134 | - 'TabSeparatedRaw': 'formats/tabseparatedraw.md' |
| 135 | - 'TabSeparatedWithNames': 'formats/tabseparatedwithnames.md' |
| 136 | - 'TabSeparatedWithNamesAndTypes': 'formats/tabseparatedwithnamesandtypes.md' |
| 137 | - 'CSV': 'formats/csv.md' |
| 138 | - 'CSVWithNames': 'formats/csvwithnames.md' |
| 139 | - 'Values': 'formats/values.md' |
| 140 | - 'Vertical': 'formats/vertical.md' |
| 141 | - 'VerticalRaw': 'formats/verticalraw.md' |
| 142 | - 'JSON': 'formats/json.md' |
| 143 | - 'JSONCompact': 'formats/jsoncompact.md' |
| 144 | - 'JSONEachRow': 'formats/jsoneachrow.md' |
| 145 | - 'TSKV': 'formats/tskv.md' |
| 146 | - 'Pretty': 'formats/pretty.md' |
| 147 | - 'PrettyCompact': 'formats/prettycompact.md' |
| 148 | - 'PrettyCompactMonoBlock': 'formats/prettycompactmonoblock.md' |
| 149 | - 'PrettyNoEscapes': 'formats/prettynoescapes.md' |
| 150 | - 'PrettySpace': 'formats/prettyspace.md' |
| 151 | - 'RowBinary': 'formats/rowbinary.md' |
| 152 | - 'Native': 'formats/native.md' |
| 153 | - 'Null': 'formats/null.md' |
| 154 | - 'XML': 'formats/xml.md' |
| 155 | - 'CapnProto': 'formats/capnproto.md' |
| 156 | |
| 157 | - 'Data types': |
| 158 | - 'Introduction': 'data_types/index.md' |
| 159 | - 'UInt8, UInt16, UInt32, UInt64, Int8, Int16, Int32, Int64': 'data_types/int_uint.md' |
| 160 | - 'Float32, Float64': 'data_types/float.md' |
| 161 | - 'Boolean values': 'data_types/boolean.md' |
| 162 | - 'String': 'data_types/string.md' |
| 163 | - 'FixedString(N)': 'data_types/fixedstring.md' |
| 164 | - 'Date': 'data_types/date.md' |
| 165 | - 'DateTime': 'data_types/datetime.md' |
| 166 | - 'Enum': 'data_types/enum.md' |
| 167 | - 'Array(T)': 'data_types/array.md' |
| 168 | - 'AggregateFunction(name, types_of_arguments...)': 'data_types/nested_data_structures/aggregatefunction.md' |
| 169 | - 'Tuple(T1, T2, ...)': 'data_types/tuple.md' |
| 170 | - 'Nested data structures': |
| 171 | # - 'Вложенные структуры данных': 'data_types/nested_data_structures/index.md' |
| 172 | - 'Nested(Name1 Type1, Name2 Type2, ...)': 'data_types/nested_data_structures/nested.md' |
| 173 | - 'Special data types': |
| 174 | # - 'Служебные типы данных': 'data_types/special_data_types/index.md' |
| 175 | - 'Expression': 'data_types/special_data_types/expression.md' |
| 176 | - 'Set': 'data_types/special_data_types/set.md' |
| 177 | |
| 178 | - 'Operators': 'operators/index.md' |
| 179 | |
| 180 | - 'Functions': |
| 181 | - 'Introduction': 'functions/index.md' |
| 182 | - 'Arithmetic functions': 'functions/arithmetic_functions.md' |
| 183 | - 'Comparison functions': 'functions/comparison_functions.md' |
| 184 | - 'Logical functions': 'functions/logical_functions.md' |
| 185 | - 'Type conversion functions': 'functions/type_conversion_functions.md' |
| 186 | - 'Functions for working with dates and times': 'functions/date_time_functions.md' |
| 187 | - 'Functions for working with strings': 'functions/string_functions.md' |
| 188 | - 'Functions for searching strings': 'functions/string_search_functions.md' |
| 189 | - 'Functions for searching and replacing in strings': 'functions/string_replace_functions.md' |
| 190 | - 'Conditional functions': 'functions/conditional_functions.md' |
| 191 | - 'Mathematical functions': 'functions/math_functions.md' |
| 192 | - 'Rounding functions': 'functions/rounding_functions.md' |
| 193 | - 'Functions for working with arrays': 'functions/array_functions.md' |
| 194 | - 'Functions for splitting and merging strings and arrays': 'functions/splitting_merging_functions.md' |
| 195 | - 'Bit functions': 'functions/bit_functions.md' |
| 196 | - 'Hash functions': 'functions/hash_functions.md' |
| 197 | - 'Functions for generating pseudo-random numbers': 'functions/random_functions.md' |
| 198 | - 'Encoding functions': 'functions/encoding_functions.md' |
| 199 | - 'Functions for working with URLs': 'functions/url_functions.md' |
| 200 | - 'Functions for working with IP addresses': 'functions/ip_address_functions.md' |
| 201 | - 'Functions for working with JSON.': 'functions/json_functions.md' |
| 202 | - 'Higher-order functions': 'functions/higher_order_functions.md' |
| 203 | - 'Other functions': 'functions/other_functions.md' |
| 204 | - 'Functions for working with external dictionaries': 'functions/ext_dict_functions.md' |
| 205 | - 'Functions for working with Yandex.Metrica dictionaries': 'functions/ym_dict_functions.md' |
| 206 | - 'Functions for implementing the IN operator': 'functions/in_functions.md' |
| 207 | - 'arrayJoin function': 'functions/array_join.md' |
| 208 | |
| 209 | - 'Aggregate functions': |
| 210 | - 'Introduction': 'agg_functions/index.md' |
| 211 | - 'Function reference': 'agg_functions/reference.md' |
| 212 | - 'Aggregate function combinators': 'agg_functions/combinators.md' |
| 213 | - 'Parametric aggregate functions': 'agg_functions/parametric_functions.md' |
| 214 | |
| 215 | - 'Dictionaries': |
| 216 | - 'Introduction': 'dicts/index.md' |
| 217 | - 'External dictionaries': |
| 218 | - 'General desription': 'dicts/external_dicts.md' |
| 219 | - 'Configuring an external dictionary': 'dicts/external_dicts_dict.md' |
| 220 | - 'Storing dictionaries in memory': 'dicts/external_dicts_dict_layout.md' |
| 221 | - 'Dictionary updates': 'dicts/external_dicts_dict_lifetime.md' |
| 222 | - 'Sources of external dictionaries': 'dicts/external_dicts_dict_sources.md' |
| 223 | - 'Dictionary key and fields': 'dicts/external_dicts_dict_structure.md' |
| 224 | - 'Internal dictionaries': 'dicts/internal_dicts.md' |
| 225 | |
| 226 | - 'Operations': |
| 227 | - 'Operations': 'operations/index.md' |
| 228 | - 'Access rights': 'operations/access_rights.md' |
| 229 | - 'Configuration files': 'operations/configuration_files.md' |
| 230 | - 'Quotas': 'operations/quotas.md' |
| 231 | - 'Usage recommendations': 'operations/tips.md' |
| 232 | - 'Server configuration parameters': |
| 233 | - 'Introduction': 'operations/server_settings/index.md' |
| 234 | - 'Server settings': 'operations/server_settings/settings.md' |
| 235 | - 'Settings': |
| 236 | - 'Introduction': 'operations/settings/index.md' |
| 237 | - 'Restrictions on query complexity': 'operations/settings/query_complexity.md' |
| 238 | - 'Settings': 'operations/settings/settings.md' |
| 239 | - 'Settings profiles': 'operations/settings/settings_profiles.md' |
| 240 | |
| 241 | - 'Utilities': |
| 242 | - 'Introduction': 'utils/index.md' |
| 243 | - 'clickhouse-copier': 'utils/clickhouse-copier.md' |
| 244 | - 'clickhouse-local': 'utils/clickhouse-local.md' |
| 245 | |
| 246 | - 'ClickHouse Development': |
| 247 | # - 'ClickHouse Development': 'development/index.md' |
| 248 | - 'Overview of ClickHouse architecture': 'development/architecture.md' |
| 249 | - 'How to build ClickHouse on Linux': 'development/build.md' |
| 250 | - 'How to build ClickHouse on Mac OS X': 'development/build_osx.md' |
| 251 | - 'How to write C++ code': 'development/style.md' |
| 252 | - 'How to run ClickHouse tests': 'development/tests.md' |
| 253 | |
| 254 | - 'Roadmap': 'roadmap.md' |