Release Notes
- 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
Data Loading
Data Unloading
Query Data Sources
Query Acceleration
- Gather CBO statistics
- Synchronous materialized view
- Asynchronous materialized view
- 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
- Performance Tuning
Reference
- SQL Reference
- Function Reference
  - Java UDFs
  - Window functions
  - Lambda expression
  - Aggregate Functions
    - array_agg
    - avg
    - any_value
    - approx_count_distinct
    - bitmap
    - bitmap_agg
    - count
    - grouping
    - grouping_id
    - 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
    - cardinality
    - element_at
    - 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
  - JSON Functions
    - Overview of JSON functions and operators
    - JSON operators
    - JSON constructor functions
    - JSON query and processing functions
  - Map Functions
    - cardinality
    - element_at
    - map_apply
    - map_filter
    - map_from_arrays
    - map_keys
    - map_size
    - map_values
    - transform_keys
    - transform_values
  - Binary Functions
    - to_binary
    - from_binary
  - Conditional Functions
    - case
    - coalesce
    - if
    - ifnull
    - nullif
  - Cryptographic Functions
    - aes_encrypt
    - aes_decrypt
    - base64_decode_binary
    - base64_decode_string
    - 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_add
    - hours_diff
    - hours_sub
    - microseconds_add
    - microseconds_sub
    - minute
    - minutes_add
    - minutes_diff
    - minutes_sub
    - month
    - monthname
    - months_add
    - months_diff
    - months_sub
    - 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
    - week_iso
    - 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
  - Math Functions
    - abs
    - acos
    - asin
    - atan
    - atan2
    - bin
    - ceil
    - ceiling
    - conv
    - cos
    - cosh
    - 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
    - sinh
    - sqrt
    - square
    - tan
    - tanh
    - 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
    - hex_decode_binary
    - hex_decode_string
    - instr
    - lcase
    - left
    - length
    - locate
    - lower
    - lpad
    - ltrim
    - money_format
    - null_or_empty
    - parse_url
    - repeat
    - replace
    - 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
    - current_role
    - current_version
    - host_name
    - isnull
    - last_query_id
    - sleep
    - uuid
    - uuid_numeric
    - version
  - cast function
  - hash function
- System variables
- User-defined variables
- Error code
- System limits
FAQ
- Deploy
- Data Migration
  - Data Loading
  - Data Unloading
- SQL
- query_dump
- Other FAQs
Benchmark
- SSB Benchmark
- TPC-H Benchmark

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

Edit

Deployment prerequisites

This topic describes the hardware and software requirements that your servers must meet before deploying StarRocks. For recommended hardware specifications of your StarRocks cluster, see Plan your StarRocks cluster.

Hardware

CPU

StarRocks relies on AVX2 instruction sets to fully unleash its vectorization capability. Therefore, in a production environment, we highly recommend you deploy StarRocks on machines with x86 architecture CPUs.

You can run the following command in your terminal to check if the CPUs on your machines support the AVX2 instruction sets:

cat /proc/cpuinfo | grep avx2

NOTE
ARM architecture does not support SIMD instruction sets, and therefore is less competitive than x86 architecture in some scenarios. Therefore, we only recommend deploying StarRocks on ARM architecture in a development environment.

Memory

No specific requirement is imposed on memory kits used for StarRocks. See Plan StarRocks cluster - CPU and Memory for the recommended memory size.

Storage

StarRocks supports both HDD and SSD as storage medium.

If your applications require real-time data analytics, intensive data scans, or random disk access, we strongly recommend you use SSD storage.

If your applications involve Primary Key tables with the persistent index, you must use SSD storage.

Network

We recommend that you use 10 Gigabit Ethernet networking to ensure stable data transmission across nodes within your StarRocks cluster.

Operating system

StarRocks supports deployments on CentOS 7.9 or Ubuntu 22.04.

Software

You must install JDK 1.8.0 on your servers to run StarRocks.

NOTE
StarRocks does not support JRE.

Follow these steps to install JDK:

Navigate to the path for the JDK installation.

Download JDK by running the following command:

wget --no-check-certificate --no-cookies \
    --header "Cookie: oraclelicense=accept-securebackup-cookie"  \
    http://download.oracle.com/otn-pub/java/jdk/8u131-b11/d54c1d3a095b4ff2b6607d096fa80163/jdk-8u131-linux-x64.tar.gz

Edit

In this article

Deployment prerequisites