Release Notes
- v3.1
- v3.0
- v2.5
- v2.4
- v2.3
- v2.2
- v2.1
- v2.0
- v1.19

StarRocks
Introduction to StarRocks
Quick Start
Deployment
- Deployment overview
- Prepare
- Deploy
  - Deploy classic StarRocks
    - Deploy StarRocks manually
    - Deploy on Kubernetes
      - Deploy StarRocks with Operator
      - Deploy StarRocks with Helm
    - Deploy StarRocks on AWS
  - Deploy and use shared-data StarRocks
- Manage
Table Design
- Understand StarRocks table design
- Table types
- Data distribution
- Data compression
- Sort keys and prefix indexes
Data Loading
Data Unloading
Query Data Lakes
Query Acceleration
- Gather CBO statistics
- Synchronous materialized views
- Asynchronous materialized views
- Colocate Join
- Lateral Join
- Query Cache
- Index
  - Bitmap indexing
  - Bloom filter indexing
- Computing the Number of Distinct Values
  - Use Bitmap for exact count distinct
  - Use HLL for approximate count distinct
- Sorted streaming aggregate
Administration
- Management
- Data recovery
- User Privilege and Authentication
  - User privilege
  - Authentication
- Performance Tuning
Reference
- SQL Reference
- Function Reference
  - Function list
  - Java UDFs
  - Window functions
  - Lambda expression
  - Aggregate Functions
    - any_value
    - approx_count_distinct
    - array_agg
    - avg
    - bitmap
    - bitmap_agg
    - count
    - corr
    - covar_pop
    - covar_samp
    - group_concat
    - grouping
    - grouping_id
    - group_concat
    - hll_empty
    - hll_hash
    - hll_raw_agg
    - hll_union
    - hll_union_agg
    - max
    - max_by
    - min
    - multi_distinct_sum
    - multi_distinct_count
    - percentile_approx
    - percentile_cont
    - percentile_disc
    - retention
    - stddev
    - stddev_samp
    - sum
    - variance, variance_pop, var_pop
    - var_samp
    - window_funnel
  - Array Functions
    - array_agg
    - array_append
    - array_avg
    - array_concat
    - array_contains
    - array_contains_all
    - array_cum_sum
    - array_difference
    - array_distinct
    - array_filter
    - array_intersect
    - array_join
    - array_length
    - array_map
    - array_max
    - array_min
    - array_position
    - array_remove
    - array_slice
    - array_sort
    - array_sortby
    - array_sum
    - arrays_overlap
    - array_to_bitmap
    - reverse
    - unnest
  - Bit Functions
    - bitand
    - bitnot
    - bitor
    - bitxor
    - bit_shift_left
    - bit_shift_right
    - bit_shift_right_logical
  - Bitmap Functions
    - base64_to_bitmap
    - bitmap_agg
    - bitmap_and
    - bitmap_andnot
    - bitmap_contains
    - bitmap_count
    - bitmap_from_string
    - bitmap_empty
    - bitmap_has_any
    - bitmap_hash
    - bitmap_intersect
    - bitmap_max
    - bitmap_min
    - bitmap_or
    - bitmap_remove
    - bitmap_to_array
    - bitmap_to_base64
    - bitmap_to_string
    - bitmap_union
    - bitmap_union_count
    - bitmap_union_int
    - bitmap_xor
    - intersect_count
    - sub_bitmap
    - to_bitmap
  - Conditional Functions
    - case
    - coalesce
    - if
    - ifnull
    - nullif
  - Cryptographic Functions
    - aes_encrypt
    - aes_decrypt
    - from_base64
    - md5
    - md5sum
    - md5sum_numeric
    - sha2
    - sm3
    - to_base64
  - Date Functions
    - add_months
    - adddate
    - convert_tz
    - current_date
    - current_time
    - current_timestamp
    - date
    - date_add
    - date_format
    - date_slice
    - date_sub, subdate
    - date_trunc
    - datediff
    - day
    - dayname
    - dayofmonth
    - dayofweek
    - dayofyear
    - days_add
    - days_diff
    - days_sub
    - from_days
    - from_unixtime
    - hour
    - hours_sub
    - microseconds_sub
    - minute
    - minutes_add
    - minutes_diff
    - minutes_sub
    - month
    - monthname
    - months_add
    - months_diff
    - now
    - quarter
    - second
    - seconds_add
    - seconds_diff
    - seconds_sub
    - str_to_date
    - str2date
    - time_slice
    - time_to_sec
    - timediff
    - timestamp
    - timestampadd
    - timestampdiff
    - to_date
    - to_days
    - unix_timestamp
    - utc_timestamp
    - week
    - weekofyear
    - weeks_add
    - weeks_diff
    - weeks_sub
    - year
    - years_add
    - years_diff
    - years_sub
  - Geographic Functions
    - st_astext
    - st_circle
    - st_contains
    - st_distance_sphere
    - st_geometryfromtext
    - st_linefromtext
    - st_point
    - st_polygon
    - st_x
    - st_y
  - JSON Functions
    - Overview of JSON functions and operators
    - JSON operators
    - JSON constructor functions
    - JSON query and processing functions
  - Map Functions
    - map_keys
    - map_size
    - map_values
  - Math Functions
    - abs
    - acos
    - asin
    - atan
    - atan2
    - bin
    - ceil
    - ceiling
    - conv
    - cos
    - cosine_similarity
    - cosine_similarity_norm
    - cot
    - degrees
    - divide
    - e
    - exp
    - floor
    - fmod
    - greatest
    - least
    - ln
    - log
    - log2
    - log10
    - mod
    - multiply
    - negative
    - pi
    - pmod
    - positive
    - pow
    - radians
    - rand
    - round
    - sign
    - sin
    - sqrt
    - square
    - tan
    - truncate
  - String Functions
    - append_trailing_char_if_absent
    - ascii
    - char
    - char_length
    - character_length
    - concat
    - concat_ws
    - ends_with
    - find_in_set
    - group_concat
    - hex
    - instr
    - lcase
    - left
    - length
    - locate
    - lower
    - lpad
    - ltrim
    - money_format
    - null_or_empty
    - parse_url
    - repeat
    - reverse
    - right
    - rpad
    - rtrim
    - space
    - split
    - split_part
    - starts_with
    - strleft
    - strright
    - substring
    - trim
    - ucase
    - unhex
    - upper
  - Pattern Matching Functions
    - like
    - regexp
    - regexp_extract
    - regexp_replace
  - Percentile Functions
    - percentile_approx_raw
    - percentile_empty
    - percentile_hash
    - percentile_union
  - Scalar Functions
    - hll_cardinality
  - Utility Functions
    - catalog
    - current_version
    - database
    - host_name
    - isnull
    - last_query_id
    - sleep
    - uuid
    - uuid_numeric
    - version
  - cast function
  - hash function
- System variables
- User-defined variables
- Error code
- System limits
- AWS IAM policies
FAQ
- Deploy
- Data Migration
  - Data Loading
  - Data Unloading
- SQL
- query_dump
- Other FAQs
Benchmark
- SSB Benchmark
- TPC-H Benchmark
Ecosystem Release Notes

Developers
- Contribute to StarRocks
- Code Style Guides
  - protobuf style guides
  - thrift style guides
- Use the debuginfo file for debugging
- Development Environment
- Trace Tools
  - Trace

Edit

Deployment overview

This chapter describes how to deploy, upgrade, and downgrade a StarRocks cluster in a production environment.

Deployment procedure

A summary of the deployment procedure is as follows and later topics provide the details.

The deployment of StarRocks generally follows the steps outlined here:

Confirm the hardware and software requirements for your StarRocks deployment.
Check the prerequisites that your servers must meet before deploying StarRocks, including CPU, memory, storage, network, operating system, and dependencies.
Plan your cluster size.
Plan the number of FE nodes and BE nodes in your cluster, and the hardware specifications of the servers.
Check environment configurations.
When your servers are ready, you need to check and modify some environment configurations before deploying StarRocks on them.
Prepare deployment files.
- If you want to deploy StarRocks on x86-based CentOS 7.9, you can directly download and extract the software package provided on our official website.
- If you want to deploy StarRocks with ARM architecture CPUs or on Ubuntu 22.04, you need to prepare the deployment files from the StarRocks Docker image.
- If you want to deploy StarRocks on Kubernetes, you can skip this step.
Deploy StarRocks.
- If you want to deploy a shared-data StarRocks cluster, which features a disaggregated storage and compute architecture, see Deploy and use shared-data StarRocks for instructions.
- If you want to deploy a classic StarRocks cluster, which uses local storage, you have the following options:
Perform necessary post-deployment setup measures.
Further setup measures are needed before your StarRocks cluster is put into production. These measures include securing the initial account and setting some performance-related system variables.

Upgrade and downgrade

If you plan to upgrade an existing StarRocks cluster to a later version rather than install StarRocks for the first time, see Upgrade StarRocks for information about upgrade procedures and issues that you should consider before upgrading.

For instructions to downgrade your StarRocks cluster, see Downgrade StarRocks.

Edit

In this article

Deployment overview
- Deployment procedure
- Upgrade and downgrade