mirror of
https://github.com/ClickHouse/ClickHouse.git
synced 2024-11-19 06:01:57 +00:00
361a27485d
* update presentations * CLICKHOUSE-2936: redirect from clickhouse.yandex.ru and clickhouse.yandex.com * update submodule * lost files * CLICKHOUSE-2981: prefer sphinx docs over original reference * CLICKHOUSE-2981: docs styles more similar to main website + add flags to switch language links * update presentations * Less confusing directory structure (docs -> doc/reference/) * Minify sphinx docs too * Website release script: fail fast + pass docker hash on deploy * Do not underline links in docs * shorter * cleanup docker images * tune nginx config * CLICKHOUSE-3043: get rid of habrastorage links * Lost translation * CLICKHOUSE-2936: temporary client-side redirect * behaves weird in test * put redirect back * CLICKHOUSE-3047: copy docs txts to public too * move to proper file * remove old pages to avoid confusion * Remove reference redirect warning for now * Refresh README.md * Yellow buttons in docs * Use svg flags instead of unicode ones in docs * fix test website instance * Put flags to separate files * wrong flag * Copy Yandex.Metrica introduction from main page to docs * Yet another home page structure change, couple new blocks (CLICKHOUSE-3045) * Update Contacts section * CLICKHOUSE-2849: more detailed legal information * CLICKHOUSE-2978 preparation - split by files * More changes in Contacts block * Tune texts on index page * update presentations * One more benchmark * Add usage sections to index page, adapted from slides * Get the roadmap started, based on slides from last ClickHouse Meetup * CLICKHOUSE-2977: some rendering tuning * Get rid of excessive section in the end of getting started * Make headers linkable * CLICKHOUSE-2981: links to editing reference - https://github.com/yandex/ClickHouse/issues/849 * CLICKHOUSE-2981: fix mobile styles in docs * Ban crawling of duplicating docs * Open some external links in new tab * Ban old docs too * Lots of trivial fixes in english docs * Lots of trivial fixes in russian docs * Remove getting started copies in markdown * Add Yandex.Webmaster * Fix some sphinx warnings * More warnings fixed in english docs * More sphinx warnings fixed * Add code-block:: text * More code-block:: text * These headers look not that well * Better switch between documentation languages * merge use_case.rst into ya_metrika_task.rst * Edit the agg_functions.rst texts * Add lost empty lines * Lost blank lines * Add new logo sizes * update presentations * Next step in migrating to new documentation * Fix all warnings in en reference * Fix all warnings in ru reference * Re-arrange existing reference * Move operation tips to main reference * Fix typos noticed by milovidov@ * Get rid of zookeeper.md * Looks like duplicate of tutorial.html * Fix some mess with html tags in tutorial * No idea why nobody noticed this before, but it was completely not clear whet to get the data * Match code block styling between main and tutorial pages (in favor of the latter) * Get rid of some copypaste in tutorial * Normalize header styles * Move example_datasets to sphinx * Move presentations submodule to website * Move and update README.md * No point in duplicating articles from habrahabr here * Move development-related docs as is for now * doc/reference/ -> docs/ (to match the URL on website) * Adapt links to match the previous commit * Adapt development docs to rst (still lacks translation and strikethrough support) * clean on release * blacklist presentations in gulp * strikethrough support in sphinx * just copy development folder for now * fix weird introduction in style article * Style guide translation (WIP) * Finish style guide translation to English * gulp clean separately * Update year in LICENSE * Initial CONTRIBUTING.md * Fix remaining links to old docs in tutorial * Some tutorial fixes * Typo * Another typo * Update list of authors from yandex-team accoding to git log * Fix diff with master * couple fixes in en what_is_clickhouse.rst * Try different link to blog in Russian * Swap words * Slightly larger line height * CLICKHOUSE-3089: disable hyphenation in docs * update presentations * Fix copying of txt files * update submodule * CLICKHOUSE-3108: fix overflow issues in mobile version * Less weird tutorial header in mobile version * CLICKHOUSE-3073: skip sourcemaps by default * CLICKHOUSE-3067: rename item in docs navigation * fix list markup * CLICKHOUSE-3067: some documentation style tuning * CLICKHOUSE-3067: less laggy single page documentation * update presentations * YQL-3278: add some links to ClickHouse Meetup in Berlin on October 5, 2017 * Add "time series" keyword * Switch link to next event * Switch link to next event #2 * smaller font * Remove Palo Alto link * Add link to Success stories list * better title * Update index.html * Update index.html * Do not expect gulp in $PATH * Add link to Beijing meetup * ignore presentations * introduce requirements.txt * Apply hacks by bayonet@ using monkey patching * Simplify and fix patching of "single" docs on Mac OS (it still has a bug on chunk borders though) * remove hidden symbol * s/2016–2017/2016–2018/g * Add some place to put virtualenv * mkdocs was missing from requirements.txt * This way it hurts eyes less * Change header layout + add flags * yandex_fonts.css -> custom.css * Larger docs logo * Shorter link * Link to home from logo * Borrow some more styles from main page * Tune some links * Remove shadow * Add header border * Header font * Better flag margin * Improve single page mode * Fix search results hover * Fix some MarkDown errors * Silence useless error * Get rid of index.html's * Enable syntax highlight * Fix link label in ru * More style fixes in documentation scripts
247 lines
11 KiB
YAML
247 lines
11 KiB
YAML
site_name: ClickHouse Documentation
|
||
copyright: ©2016–2018 Yandex LLC
|
||
|
||
docs_dir: en
|
||
site_dir: build/docs/en
|
||
use_directory_urls: true
|
||
|
||
repo_name: 'yandex/ClickHouse'
|
||
repo_url: 'https://github.com/yandex/ClickHouse/'
|
||
edit_uri: 'edit/master/docs/en'
|
||
|
||
extra_css:
|
||
- assets/stylesheets/custom.css
|
||
|
||
theme:
|
||
name: null
|
||
custom_dir: 'mkdocs-material-theme'
|
||
language: 'en'
|
||
feature:
|
||
tabs: false
|
||
palette:
|
||
primary: 'white'
|
||
accent: 'white'
|
||
font: false
|
||
# text: Roboto
|
||
# code: Roboto Mono
|
||
logo: 'images/logo.svg'
|
||
favicon: 'assets/images/favicon.ico'
|
||
include_search_page: false
|
||
search_index_only: true
|
||
static_templates:
|
||
- 404.html
|
||
|
||
extra:
|
||
single_page: false
|
||
search:
|
||
language: 'en'
|
||
|
||
markdown_extensions:
|
||
- codehilite
|
||
|
||
pages:
|
||
- 'ClickHouse': 'index.md'
|
||
|
||
- 'Introduction':
|
||
# - 'Введение': 'introduction/index.md'
|
||
- 'Distinctive features of ClickHouse': 'introduction/distinctive_features.md'
|
||
- 'ClickHouse features that can be considered disadvantages': 'introduction/features_considered_disadvantages.md'
|
||
- 'The Yandex.Metrica task': 'introduction/ya_metrika_task.md'
|
||
- 'Everything you were afraid to ask': 'introduction/possible_silly_questions.md'
|
||
- 'Performance': 'introduction/performance.md'
|
||
|
||
- 'Getting started':
|
||
- 'Deploying and running': 'getting_started/index.md'
|
||
- 'Testing data':
|
||
- 'AMPLab Big Data Benchmark': 'getting_started/example_datasets/amplab_benchmark.md'
|
||
- 'Terabyte of click logs from Criteo': 'getting_started/example_datasets/criteo.md'
|
||
- 'Data about New York taxis': 'getting_started/example_datasets/nyc_taxi.md'
|
||
- 'OnTime': 'getting_started/example_datasets/ontime.md'
|
||
- 'Star scheme': 'getting_started/example_datasets/star_schema.md'
|
||
- 'WikiStat': 'getting_started/example_datasets/wikistat.md'
|
||
|
||
- 'Interfaces':
|
||
- 'Interfaces': 'interfaces/index.md'
|
||
- 'Command-line client': 'interfaces/cli.md'
|
||
- 'HTTP interface': 'interfaces/http_interface.md'
|
||
- 'JDBC driver': 'interfaces/jdbc.md'
|
||
- 'Native interface (TCP)': 'interfaces/tcp.md'
|
||
- 'Libraries from third-party developers': 'interfaces/third-party_client_libraries.md'
|
||
- 'Visual interfaces from third-party developers': 'interfaces/third-party_gui.md'
|
||
|
||
- 'Query language':
|
||
# - 'Query language': 'query_language/index.md'
|
||
- 'Queries': 'query_language/queries.md'
|
||
- 'Syntax': 'query_language/syntax.md'
|
||
- 'The clickhouse-local program': 'query_language/clickhouse_local.md'
|
||
|
||
- 'Table engines':
|
||
- 'Introduction': 'table_engines/index.md'
|
||
- 'AggregatingMergeTree': 'table_engines/aggregatingmergetree.md'
|
||
- 'Buffer': 'table_engines/buffer.md'
|
||
- 'CollapsingMergeTree': 'table_engines/collapsingmergetree.md'
|
||
- 'Custom partitioning key': 'table_engines/custom_partitioning_key.md'
|
||
- 'Distributed': 'table_engines/distributed.md'
|
||
- 'External data for query processing': 'table_engines/external_data.md'
|
||
- 'File(InputFormat)': 'table_engines/file.md'
|
||
- 'GraphiteMergeTree': 'table_engines/graphitemergetree.md'
|
||
- 'Join': 'table_engines/join.md'
|
||
- 'Kafka': 'table_engines/kafka.md'
|
||
- 'Log': 'table_engines/log.md'
|
||
- 'MaterializedView': 'table_engines/materializedview.md'
|
||
- 'Memory': 'table_engines/memory.md'
|
||
- 'Merge': 'table_engines/merge.md'
|
||
- 'MergeTree': 'table_engines/mergetree.md'
|
||
- 'Null': 'table_engines/null.md'
|
||
- 'ReplacingMergeTree': 'table_engines/replacingmergetree.md'
|
||
- 'Data replication': 'table_engines/replication.md'
|
||
- 'Set': 'table_engines/set.md'
|
||
- 'SummingMergeTree': 'table_engines/summingmergetree.md'
|
||
- 'TinyLog': 'table_engines/tinylog.md'
|
||
- 'View': 'table_engines/view.md'
|
||
|
||
- 'System tables':
|
||
- 'Introduction': 'system_tables/index.md'
|
||
- 'system.asynchronous_metrics': 'system_tables/system.asynchronous_metrics.md'
|
||
- 'system.clusters': 'system_tables/system.clusters.md'
|
||
- 'system.columns': 'system_tables/system.columns.md'
|
||
- 'system.databases': 'system_tables/system.databases.md'
|
||
- 'system.dictionaries': 'system_tables/system.dictionaries.md'
|
||
- 'system.events': 'system_tables/system.events.md'
|
||
- 'system.functions': 'system_tables/system.functions.md'
|
||
- 'system.merges': 'system_tables/system.merges.md'
|
||
- 'system.metrics': 'system_tables/system.metrics.md'
|
||
- 'system.numbers': 'system_tables/system.numbers.md'
|
||
- 'system.numbers_mt': 'system_tables/system.numbers_mt.md'
|
||
- 'system.one': 'system_tables/system.one.md'
|
||
- 'system.parts': 'system_tables/system.parts.md'
|
||
- 'system.processes': 'system_tables/system.processes.md'
|
||
- 'system.replicas': 'system_tables/system.replicas.md'
|
||
- 'system.settings': 'system_tables/system.settings.md'
|
||
- 'system.tables': 'system_tables/system.tables.md'
|
||
- 'system.zookeeper': 'system_tables/system.zookeeper.md'
|
||
|
||
- 'Table functions':
|
||
- 'Introduction': 'table_functions/index.md'
|
||
- 'merge': 'table_functions/merge.md'
|
||
- 'remote': 'table_functions/remote.md'
|
||
|
||
- 'Formats':
|
||
- 'Introduction': 'formats/index.md'
|
||
- 'CapnProto': 'formats/capnproto.md'
|
||
- 'CSV': 'formats/csv.md'
|
||
- 'CSVWithNames': 'formats/csvwithnames.md'
|
||
- 'JSON': 'formats/json.md'
|
||
- 'JSONCompact': 'formats/jsoncompact.md'
|
||
- 'JSONEachRow': 'formats/jsoneachrow.md'
|
||
- 'Native': 'formats/native.md'
|
||
- 'Null': 'formats/null.md'
|
||
- 'Pretty': 'formats/pretty.md'
|
||
- 'PrettyCompact': 'formats/prettycompact.md'
|
||
- 'PrettyCompactMonoBlock': 'formats/prettycompactmonoblock.md'
|
||
- 'PrettyNoEscapes': 'formats/prettynoescapes.md'
|
||
- 'PrettySpace': 'formats/prettyspace.md'
|
||
- 'RowBinary': 'formats/rowbinary.md'
|
||
- 'TabSeparated': 'formats/tabseparated.md'
|
||
- 'TabSeparatedRaw': 'formats/tabseparatedraw.md'
|
||
- 'TabSeparatedWithNames': 'formats/tabseparatedwithnames.md'
|
||
- 'TabSeparatedWithNamesAndTypes': 'formats/tabseparatedwithnamesandtypes.md'
|
||
- 'TSKV': 'formats/tskv.md'
|
||
- 'Values': 'formats/values.md'
|
||
- 'Vertical': 'formats/vertical.md'
|
||
- 'XML': 'formats/xml.md'
|
||
|
||
- 'Data types':
|
||
- 'Introduction': 'data_types/index.md'
|
||
- 'Array(T)': 'data_types/array.md'
|
||
- 'Boolean values': 'data_types/boolean.md'
|
||
- 'Date': 'data_types/date.md'
|
||
- 'DateTime': 'data_types/datetime.md'
|
||
- 'Enum': 'data_types/enum.md'
|
||
- 'FixedString(N)': 'data_types/fixedstring.md'
|
||
- 'Float32, Float64': 'data_types/float.md'
|
||
- 'UInt8, UInt16, UInt32, UInt64, Int8, Int16, Int32, Int64': 'data_types/int_uint.md'
|
||
- 'String': 'data_types/string.md'
|
||
- 'Tuple(T1, T2, ...)': 'data_types/tuple.md'
|
||
- 'Nested data structures':
|
||
# - 'Вложенные структуры данных': 'data_types/nested_data_structures/index.md'
|
||
- 'AggregateFunction(name, types_of_arguments...)': 'data_types/nested_data_structures/aggregatefunction.md'
|
||
- 'Nested(Name1 Type1, Name2 Type2, ...)': 'data_types/nested_data_structures/nested.md'
|
||
- 'Special data types':
|
||
# - 'Служебные типы данных': 'data_types/special_data_types/index.md'
|
||
- 'Expression': 'data_types/special_data_types/expression.md'
|
||
- 'Set': 'data_types/special_data_types/set.md'
|
||
|
||
- 'Operators': 'operators/index.md'
|
||
|
||
- 'Functions':
|
||
- 'Introduction': 'functions/index.md'
|
||
- 'Arithmetic functions': 'functions/arithmetic_functions.md'
|
||
- 'Functions for working with arrays': 'functions/array_functions.md'
|
||
- 'arrayJoin function': 'functions/array_join.md'
|
||
- 'Bit functions': 'functions/bit_functions.md'
|
||
- 'Comparison functions': 'functions/comparison_functions.md'
|
||
- 'Conditional functions': 'functions/conditional_functions.md'
|
||
- 'Functions for working with dates and times': 'functions/date_time_functions.md'
|
||
- 'Encoding functions': 'functions/encoding_functions.md'
|
||
- 'Functions for working with external dictionaries': 'functions/ext_dict_functions.md'
|
||
- 'Hash functions': 'functions/hash_functions.md'
|
||
- 'Higher-order functions': 'functions/higher_order_functions.md'
|
||
- 'Functions for implementing the IN operator': 'functions/in_functions.md'
|
||
- 'Functions for working with IP addresses': 'functions/ip_address_functions.md'
|
||
- 'Functions for working with JSON.': 'functions/json_functions.md'
|
||
- 'Logical functions': 'functions/logical_functions.md'
|
||
- 'Mathematical functions': 'functions/math_functions.md'
|
||
- 'Other functions': 'functions/other_functions.md'
|
||
- 'Functions for generating pseudo-random numbers': 'functions/random_functions.md'
|
||
- 'Rounding functions': 'functions/rounding_functions.md'
|
||
- 'Functions for splitting and merging strings and arrays': 'functions/splitting_merging_functions.md'
|
||
- 'Functions for working with strings': 'functions/string_functions.md'
|
||
- 'Functions for searching and replacing in strings': 'functions/string_replace_functions.md'
|
||
- 'Functions for searching strings': 'functions/string_search_functions.md'
|
||
- 'Type conversion functions': 'functions/type_conversion_functions.md'
|
||
- 'Functions for working with URLs': 'functions/url_functions.md'
|
||
- 'Functions for working with Yandex.Metrica dictionaries': 'functions/ym_dict_functions.md'
|
||
|
||
- 'Aggregate functions':
|
||
- 'Introduction': 'agg_functions/index.md'
|
||
- 'Function reference': 'agg_functions/reference.md'
|
||
- 'Aggregate function combinators': 'agg_functions/combinators.md'
|
||
- 'Parametric aggregate functions': 'agg_functions/parametric_functions.md'
|
||
|
||
- 'Dictionaries':
|
||
- 'Introduction': 'dicts/index.md'
|
||
- 'External dictionaries':
|
||
- 'External dictionaries': 'dicts/external_dicts.md'
|
||
- 'Configuring an external dictionary': 'dicts/external_dicts_dict.md'
|
||
- 'Storing dictionaries in memory': 'dicts/external_dicts_dict_layout.md'
|
||
- 'Dictionary updates': 'dicts/external_dicts_dict_lifetime.md'
|
||
- 'Sources of external dictionaries': 'dicts/external_dicts_dict_sources.md'
|
||
- 'Dictionary key and fields': 'dicts/external_dicts_dict_structure.md'
|
||
- 'Internal dictionaries': 'dicts/internal_dicts.md'
|
||
|
||
- 'Operation':
|
||
- 'Operation': 'operations/index.md'
|
||
- 'Access rights': 'operations/access_rights.md'
|
||
- 'Configuration files': 'operations/configuration_files.md'
|
||
- 'Quotas': 'operations/quotas.md'
|
||
- 'Usage recommendations': 'operations/tips.md'
|
||
- 'Server configuration parameters':
|
||
- 'Introduction': 'operations/server_settings/index.md'
|
||
- 'Server settings': 'operations/server_settings/settings.md'
|
||
- 'Settings':
|
||
- 'Introduction': 'operations/settings/index.md'
|
||
- 'Restrictions on query complexity': 'operations/settings/query_complexity.md'
|
||
- 'Settings': 'operations/settings/settings.md'
|
||
- 'Settings profiles': 'operations/settings/settings_profiles.md'
|
||
|
||
- 'ClickHouse Development':
|
||
# - 'ClickHouse Development': 'development/index.md'
|
||
- 'Overview of ClickHouse architecture': 'development/architecture.md'
|
||
- 'How to build ClickHouse on Linux': 'development/build.md'
|
||
- 'How to build ClickHouse on Mac OS X': 'development/build_osx.md'
|
||
- 'How to write C++ code': 'development/style.md'
|
||
- 'How to run ClickHouse tests': 'development/tests.md'
|
||
|
||
- 'Roadmap': 'roadmap.md'
|